ApsaraDB for MongoDB:Visão geral da integração

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.

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 lista 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) usa 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 por meio de comunicação via rede interna.

Endpoints.

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 rotineiras e O&M. Conceda ao usuário RAM as permissões necessárias nas instâncias do ApsaraDB for MongoDB. Use RAM to implement access control. A tabela a seguir lista as identidades de usuário compatíveis.

SDKs

• A Alibaba Cloud fornece SDKs para Java, C#, Go, Python, TypeScript, Node.js, PHP e C++. Esses SDKs gerenciam a lógica de assinatura, timeouts e novas tentativas, além de retornar objetos de resposta estruturados. Alibaba Cloud SDKs.

• 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 aliyun para gerenciar recursos cloud. What is Alibaba Cloud CLI

• Chame operações de API do ApsaraDB for MongoDB pelo Alibaba Cloud CLI. Call API in the RPC and RESTful styles.

• Tutorial passo a passo para chamar operações de API do ApsaraDB for MongoDB com o Alibaba Cloud CLI: CLI integration example.

Terraform

• O Terraform é uma ferramenta open source para visualizar, configurar e gerenciar infraestrutura cloud. Assim como o ROS, ele converte modelos em chamadas de API. What is Alibaba Cloud Terraform?

• Guia passo a passo para orquestrar recursos do ApsaraDB for MongoDB com Terraform: Terraform integration examples.

ROS

• O ROS é um service da Alibaba Cloud que simplifica o gerenciamento de recursos cloud. Crie modelos para definir recursos (como instâncias ECS e ApsaraDB RDS) e suas dependências; o ROS os cria e configura automaticamente. What is Resource Orchestration Service

• Utilize o ROS para gerenciar o ApsaraDB for MongoDB. Tipos de recursos compatíveis:

  • Recursos comuns:

    • ALIYUN::MONGODB::Instance: cria uma instância do ApsaraDB for MongoDB.

    • ALIYUN::MONGODB::ServerlessInstance: cria uma instância serverless do ApsaraDB for MongoDB.

    • ALIYUN::MONGODB::ShardingInstance: cria ou clona 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 ROS: Resource orchestration integration example.

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. Request syntax and signature method V3.

Tratamento de erros

Se uma chamada de API retornar um erro, verifique os 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.