Temos o prazer de anunciar o lançamento da versão 1.6 do Couchbase Cloudque apresenta recursos que otimizam a administração da conta, aprimoram a migração de dados e simplificam a forma como você trabalha com o Couchbase Cloud.
Nesta publicação, apresentarei uma visão geral dos novos recursos, que incluem uma API pública, um recurso aprimorado de importação de dados, uma experiência mais fácil de registro/inscrição e uma cobertura regional ampliada da AWS. Devido à sua importância para a lista de novos recursos, dedicarei a maior parte deste post à incrível nova API.
API do Couchbase Cloud
O API do Couchbase Cloud é um recurso importante e avançado que abre novas portas para a automação de operações em sua conta do Couchbase Cloud. Ele permite que você interaja programaticamente com o plano de controle do Couchbase Cloud para executar uma variedade de funções administrativas usando APIs RESTful seguras.
As APIs permitem criar e excluir clusters, buckets e usuários de banco de dados, além de listar nuvens, gerenciar projetos e muito mais. Usando as APIs, você pode criar aplicativos que automatizam tarefas manuais repetitivas, como a criação de novos clusters e usuários para novos aplicativos, e pode usá-las para integrar a funcionalidade do plano de controle a outros aplicativos ou usá-las para criar aplicativos que forneçam informações em tempo real sobre o ecossistema do banco de dados do Couchbase Cloud.
A API do Couchbase Cloud permite que os clientes se integrem ao Couchbase Cloud para realizar operações em suas contas, como:
-
- Integração/desinstalação de usuários
- Gerenciar o ciclo de vida de um cluster
- Obtenção de informações de monitoramento para um cluster
A primeira iteração da API pública concentra-se no ciclo de vida de um cluster e na funcionalidade associada. Em um alto nível, a API pode executar as seguintes funções:
Para clusters
-
- Listar, criar e excluir clusters, buckets e usuários
- Gerenciar o acesso com a Allow List
Para projetos
-
- Listar, criar e excluir projetos
Para nuvens
-
- Listar nuvens e obter informações detalhadas sobre elas
Pontos de extremidade da API
A tabela a seguir lista os endpoints e métodos da API pública que podem ser usados em seus aplicativos:
baseURL = "https://cloudapi.cloud.couchbase.com"
| API | Métodos | Descrição |
| {baseURL}/v2/status | OBTER | Retorna o status das APIs públicas |
| {baseURL}/v2/clouds | OBTER | Retorna uma lista paginada de informações resumidas sobre cada nuvem |
| {baseURL}/v2/clouds/{id} | OBTER | Retorna informações detalhadas sobre uma nuvem |
| {baseURL}/v2/projetos | GET, POST | Retorna uma lista paginada de informações resumidas sobre cada projeto ( GET ) ou para criar um projeto ( POST ) |
| {baseURL}/v2/projetos/{id} | GET, DELETE | Retorna informações detalhadas sobre um projeto ( GET ) ou o exclui ( DELETE ) |
| {baseURL}/v2/clusters | GET, POST | Retorna uma lista paginada de informações resumidas sobre cada cluster ( GET ) ou para criar um cluster ( POST ) |
| {baseURL}/v2/clusters/{id} | GET, DELETE | Retorna informações detalhadas sobre um projeto ( GET ) ou o exclui ( DELETE ) |
| {baseURL}/v2/clusters/{id}/buckets | OBTER, POSTAR, EXCLUIR | Retorna informações detalhadas sobre um bucket (GET), cria um bucket (POST) ou o exclui (DELETE) |
| {baseURL}/v2/clusters/{id}/allowlist | OBTER, POSTAR, EXCLUIR | Retorna informações detalhadas sobre uma lista de permissões ( GET ), cria uma lista de permissões ( POST ) ou a exclui ( DELETE ) |
Fluxo de informações da API
A API do Couchbase Cloud é segura, usando a criptografia TLS para comunicações. Ela também requer uma chave de acesso e uma chave secreta para autenticação e autorização.
O diagrama a seguir ilustra o fluxo de informações básicas ao usar a API:
Fluxo de informações da API do Couchbase Cloud
- Chamadas REST seguras são feitas do aplicativo de operação do cliente para os endpoints do Couchbase Cloud Public API Service.
- O serviço de API passa cada chamada para o plano de controle do Couchbase Cloud, que, por sua vez, passa a chamada para o plano de dados na conta do cliente.
- As operações são realizadas no plano de dados e as respostas são enviadas de volta pelo plano de controle para o serviço de API e, em seguida, para o aplicativo de operação do cliente.
Uso básico e chamada de um ponto de extremidade
O uso da API é simples e consiste em três etapas:
- Gerar chaves de API
- Criar chave de acesso e chave secreta usando o plano de controle do Couchbase Cloud
- Autenticar
- Gerar o cabeçalho usando autorização e Couchbase-Timestamp
- Chamar a API
- Incluir o cabeçalho de autenticação e executar a chamada REST
O Referência da API pública fornece detalhes sobre todos os endpoints disponíveis, inclusive parâmetros e respostas. Este guia de referência é um recurso essencial para conhecer os detalhes da API.
A documentação sobre como gerar as chaves e o cabeçalho da API pode ser encontrada aquiVamos dar uma olhada rápida em como chamar um endpoint de API.
Suponha que você esteja usando o Couchbase Cloud para alimentar uma variedade de aplicativos em várias nuvens e provedores de nuvem, por exemplo, AWS e Azure. Para manter operações eficientes, seria importante entender o estado atual do seu ecossistema de nuvem, qual é o status de cada nuvem em um determinado momento. Como parte de um aplicativo de operações, você pode incluir essas informações chamando a função Nuvens ponto final.
Chamando o Nuvens retorna uma lista paginada de todas as nuvens em sua conta, incluindo informações como nome, status, provedor de nuvem e região. Você chama o endpoint da seguinte forma: GET /v2/clouds
O ponto de extremidade Clouds retorna ListCloudsResponse com os campos de dados CloudSummary:
Couchbase Cloud API CloudSummary
Aqui está um exemplo simples de como chamar o Nuvens usando Python, em que o parâmetro get_clouds_from_api chama o endpoint e, em seguida, pega cada campo de nome de nuvem, provedor, região e id retornado nos dados de ListCloudsResponse e os cria em uma linha para exibição em uma tabela:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
def get_clouds_from_api(): clouds_api_response = cbc_api_get('/v2/clouds') lista_de_nuvem = [] se clouds_api_response['responseStatus'] é não Nenhum: list_of_clouds = clouds_api_response['responseContent'] # Recebemos uma lista? se list_of_clouds é não Nenhum: para nuvem em list_of_clouds["dados]: # Cria uma linha para ser exibida em uma tabela lista_de_nuvem.anexar([nuvem["nome],nuvem["provedor] , nuvem["região], nuvem['id']]) retorno(lista_de_nuvem) |
Para ver esse código em ação e experimentar uma variedade de outros aplicativos de amostra pré-criados que fazem coisas como criar e excluir clusters, listar usuários, criar projetos e muito mais, aproveite as vantagens do Exemplos da API do Couchbase CloudO aplicativo de API, um complemento completo de aplicativos funcionais que você pode usar para aprender a API e iniciar o desenvolvimento de seu próprio aplicativo. As instruções para começar a usar as amostras de API podem ser encontradas aqui.
O uso da API é tão simples quanto eficiente, permitindo que você chame de forma programática o plano de controle do Couchbase Cloud para automatizar tarefas manuais repetitivas. Por exemplo, usando a API, os clientes que utilizam o Couchbase Cloud para alimentar vários aplicativos de ciclo de vida curto - como sandboxes de desenvolvimento em que novos clusters são criados e clusters antigos são desativados com frequência - podem simplificar o processo criando um utilitário que provisiona clusters, gerencia-os e depois os destrói quando não são mais necessários.
O utilitário poderia listar resumos de nuvens, projetos, clusters e obter dados detalhados de cada um deles em tempo real, ajudando a organização a gerenciar o ecossistema do Couchbase Cloud com mais eficiência e eficácia. Este é apenas um exemplo das muitas maneiras pelas quais a API pode ser usada. Estamos entusiasmados com o novo recurso e esperamos que os clientes o utilizem muito bem!
Importação de dados aprimorada
O Couchbase Cloud 1.6 também apresenta uma funcionalidade de importação aprimorada que permite a você migrar dados para o Couchbase Cloud com mais facilidade e de novas maneiras. Usando a nova interface Import Tools, agora você pode importar arquivos JSON (linhas, lista e arquivo) e CSV para o Couchbase Cloud de um computador local usando o navegador ou manualmente usando um comando cURL fornecido pela API.
Importação do Couchbase Cloud
Um aspecto importante do novo recurso é que as chaves de cada documento extraído de uma linha CSV ou de um arquivo simples de lista JSON podem ser geradas automaticamente (UUID) ou especificadas usando uma expressão de nome de chave gerada que segue a mesma sintaxe usada pela função cbimport (que alimenta o novo recurso).
Chave personalizada na importação
A capacidade de geração de chaves personalizadas é um aprimoramento bem-vindo que simplificará e agilizará os esforços de migração de dados para os clientes do Couchbase Cloud.
Ao criar uma importação, você pode selecionar entre várias opções de configuração, incluindo Ignorar documentos, Limitar documentos, Ignorar campos, Inferir tipos de campos (somente CSV) e Omitir campos vazios (somente CSV). Outros recursos aprimorados incluem ações assíncronas ou simultâneas, rastreamento de atividades, notificações por e-mail para importações de longa duração, reimportação e muito mais.
O novo recurso de importação se torna outra maneira pela qual os clientes podem migrar dados para o Couchbase Cloud, juntamente com o Backup/Restore e o XDCR.
Outros novos recursos
Experiência de registro simplificada
Foram feitos aprimoramentos no fluxo de registro do Couchbase Cloud para orientar melhor os novos clientes durante o processo e fazer o registro da forma mais rápida e fácil possível. Para se inscrever no Couchbase Cloud, acesse Inscreva-se no Couchbase Cloud.
Cobertura ampliada da região da AWS
O Couchbase Cloud continua a aumentar suas regiões de suporte em todo o mundo e agora está disponível na região do AWS do Oriente Médio (Bahrein). Para obter uma lista completa das regiões com suporte da AWS, consulte Requisitos do provedor de nuvem para a AWS.
Meu colega Prasad Doddi escreveu um artigo detalhado sobre blog sobre o novo recurso de importação do Couchbase Cloud, que inclui um ótimo tutorial da nova interface das ferramentas de importação. Recomendo muito a leitura!
Os recursos mais recentes do Couchbase Cloud confirmam nosso compromisso de tornar o serviço o mais avançado e fácil de usar possível para os clientes.
Se você ainda não aproveitou as vantagens do Avaliação gratuita do Couchbase Cloud No entanto, agora é a hora de ver por si mesmo como é fácil começar!