O ApsaraDB for MongoDB oferece um console visual e permite integração programática por meio de operações de API, SDKs, Alibaba Cloud CLI, Terraform e ROS.ApsaraDB for MongoDB
Operações de API
O Alibaba Cloud OpenAPI Explorer permite pesquisar, depurar e chamar operações de API online, além de gerar códigos de exemplo para SDKs.O que é uma API?
Versões da API
Os números de versão da API indicam as versões principais. A versão atual do ApsaraDB for MongoDB é 2015-12-01. Apesar do formato semelhante a uma data, esse número não reflete a data da última atualização.
|
Número da versão da API |
Descrição |
|
Recomendada. |
Depuração online
O ApsaraDB for MongoDB suporta depuração de API no OpenAPI Explorer. Antes de chamar uma operação de API, verifique sua versão, endpoint e método de chamada no ApsaraDB for MongoDB.
Por exemplo, a página da operação CreateDBInstance exibe as categorias de API à esquerda, um formulário de parâmetros (RegionId, ZoneId, Engine, EngineVersion, DBInstanceClass, DBInstanceStorage, etc.) no centro e a documentação de referência à direita. Clique em Initiate Call para executar a solicitação.

Página de depuração
Depure operações de API em: https://api.alibabacloud.com/api/Dds/2015-12-01/.
Endpoints
Selecione um endpoint com base na região do recurso. Por exemplo, uma instância do ApsaraDB for MongoDB na região China (Zhangjiakou) utiliza o endpoint público mongodb.cn-zhangjiakou.aliyuncs.com e o endpoint de VPC mongodb-vpc.cn-zhangjiakou.aliyuncs.com.
Endpoints públicos são acessíveis globalmente.
-
Endpoints de VPC são acessíveis apenas dentro da VPC na região correspondente e oferecem os seguintes benefícios:
Maior segurança e privacidade.
Menor latência ao evitar a sobrecarga da Internet pública.
Custo reduzido mediante comunicação via rede interna.
Identidades compatíveis
Por padrão, o OpenAPI Explorer utiliza sua conta Alibaba Cloud para depuração. Como essa conta possui permissões totais de API, recomendamos o uso de um usuário RAM para chamadas de API rotineiras e O&M. Conceda ao usuário RAM as permissões necessárias nas instâncias do ApsaraDB for MongoDB. Usar o RAM para implementar controle de acesso. A tabela a seguir lista as identidades de usuário compatíveis.
|
Identidade do usuário |
Compatível |
|
Sim |
|
|
Usuário RAM (recomendado) |
Sim |
|
Função RAM (recomendada) |
Sim |
Métodos de integração
O ApsaraDB for MongoDB suporta os seguintes métodos de integração.
|
Método de integração |
Compatível |
|
Alibaba Cloud SDK (recomendado) |
Sim |
|
Sim |
|
|
Sim |
|
|
Sim |
|
|
Sim |
SDKs
A Alibaba Cloud fornece SDKs para Java, C#, Go, Python, TypeScript, Node.js, PHP e C++. Os SDKs gerenciam a lógica de assinatura, timeouts e novas tentativas, retornando objetos de resposta estruturados. SDKs da Alibaba Cloud.
O OpenAPI Explorer gera exemplos de código SDK para chamar operações de API do ApsaraDB for MongoDB. Linguagens e dependências compatíveis:SDK do ApsaraDB for MongoDB.
Alibaba Cloud CLI
O Alibaba Cloud CLI permite executar comandos
aliyunpara gerenciar recursos de nuvem. O que é o Alibaba Cloud CLIChame operações de API do ApsaraDB for MongoDB pelo Alibaba Cloud CLI. Chamar API nos estilos RPC e RESTful.
Tutorial passo a passo para chamar operações de API do ApsaraDB for MongoDB com o Alibaba Cloud CLI: Exemplo de integração via CLI.
Terraform
O Terraform é uma ferramenta open source para visualizar, configurar e gerenciar infraestrutura de nuvem. Assim como o ROS, o Terraform converte modelos em chamadas de API. O que é o Alibaba Cloud Terraform?
Guia passo a passo para orquestrar recursos do ApsaraDB for MongoDB com o Terraform: Exemplos de integração com Terraform.
ROS
O ROS é um serviço da Alibaba Cloud que simplifica o gerenciamento de recursos de nuvem. Você cria modelos para definir recursos (como instâncias ECS e ApsaraDB RDS) e suas dependências, e o ROS os cria e configura automaticamente. O que é o Resource Orchestration Service
-
Utilize o ROS para gerenciar o ApsaraDB for MongoDB. Tipos de recursos compatíveis:
-
Recursos comuns:
ALIYUN::MONGODB::Instance: crie uma instância do ApsaraDB for MongoDB.
ALIYUN::MONGODB::ServerlessInstance: crie uma instância serverless do ApsaraDB for MongoDB.
ALIYUN::MONGODB::ShardingInstance: crie ou clone uma instância de cluster sharded do ApsaraDB for MongoDB.
-
Recursos de dados:
DATASOURCE::MONGODB::Instances: consulta instâncias do ApsaraDB for MongoDB.
DATASOURCE::MONGODB::InstanceClasses: consulta os tipos de instância do ApsaraDB for MongoDB disponíveis em uma zona.
-
Tutorial passo a passo para orquestrar recursos do ApsaraDB for MongoDB com o ROS: Exemplo de integração de orquestração de recursos.
Encapsulamento personalizado
Caso nenhum dos métodos anteriores atenda aos seus requisitos, encapsule manualmente as solicitações de API. Este método não é recomendado. Sintaxe de solicitação e método de assinatura V3.
Tratamento de erros
Se uma chamada de API retornar um erro, verifique seus parâmetros de solicitação comparando-os com o código de erro retornado no Centro de Códigos de Erro.
Para solução autônoma de problemas, utilize a plataforma Diagnóstico da OpenAPI da Alibaba Cloud informando o RequestID da resposta ou os detalhes do erro do SDK.