O ApsaraDB RDS oferece um console para operações visuais e diversas formas de chamar operações de API, incluindo OpenAPI Explorer, SDKs da Alibaba Cloud e Resource Orchestration Service (ROS). Escolha o método de integração mais adequado ao seu fluxo de trabalho.
Visão geral do OpenAPI Explorer
O OpenAPI Explorer é uma ferramenta da Alibaba Cloud que ajuda desenvolvedores a descobrir e usar operações de API em todos os serviços da plataforma. Ela reúne busca inteligente, documentação, depuração online, baixe SDK, código de exemplo, diagnóstico de erros e estatísticas de chamadas em um único local. Use o OpenAPI Explorer para chamar operações de API e inspecionar requisições e respostas. A ferramenta também gera automaticamente códigos de exemplo de SDK para as operações testadas. Para mais informações, consulte O que é uma API?
Descrição da versão
O ApsaraDB RDS usa números de versão para gerenciar as APIs. A versão recomendada atualmente é 2014-08-15. Observe que 2014-08-15 é um identificador de versão, não uma data.
| Versão | Descrição |
|---|---|
| 2014-08-15 | Recomendada |
Depuração online
O OpenAPI Explorer oferece suporte à depuração de APIs para o ApsaraDB RDS. Antes de chamar operações de API, revise as versões disponíveis, endpoints e métodos de integração.
Página de depuração online
Acesse o OpenAPI Explorer.
Ponto de entrada para depuração: Depurar API
Endpoints
Use o endpoint da região onde sua instância está localizada para reduzir a latência. Por exemplo, para uma instância na região China (Zhangjiakou), o endpoint público é rds.cn-zhangjiakou.aliyuncs.com e o endpoint de Virtual Private Cloud (VPC) é rds-vpc.cn-zhangjiakou.aliyuncs.com.
O endpoint público tem acessibilidade global.
-
Os endpoints de VPC oferecem as seguintes vantagens em relação aos endpoints públicos:
Alta segurança: O acesso aos endpoints de VPC ocorre apenas dentro de uma VPC, o que garante maior segurança e privacidade.
Resposta rápida: Os dados trafegam pela rede da VPC, reduzindo a latência e evitando limitações de largura de banda.
Baixo custo: O tráfego pelos endpoints de VPC usa a rede interna.
Para mais informações, consulte Endpoints.
Identidades de usuário compatíveis
Por padrão, o OpenAPI Explorer usa sua conta Alibaba Cloud para depuração online. Uma conta Alibaba Cloud tem permissões totais sobre todas as operações de API, o que representa riscos de segurança. Chame operações de API e execute tarefas rotineiras de O&M com um usuário RAM ou uma função RAM. Antes de usar um usuário RAM, conceda as permissões necessárias para gerencie recursos do ApsaraDB RDS. Para mais informações, consulte Autorizar um usuário RAM a gerenciar instâncias do ApsaraDB RDS.
|
Identidade |
Compatível |
|
Sim |
|
|
RAM user (recomendado) |
Sim |
|
RAM role (recomendado) |
Sim |
Referências
Métodos de integração
O ApsaraDB RDS é compatível com SDKs da Alibaba Cloud, Alibaba Cloud CLI, ROS, Terraform e encapsulamento personalizado. Selecione o método conforme seu fluxo de trabalho.
|
Método de chamada |
Compatível |
|
Sim |
|
|
Sim |
|
|
Sim |
|
|
Sim |
|
|
Encapsulamento personalizado |
Sim |
Os SDKs são o método recomendado para a maioria dos casos de uso devido à facilidade de integração.
SDKs da Alibaba Cloud
Os SDKs da Alibaba Cloud estão disponíveis para Java, C#, Go, Python, TypeScript, Node.js, PHP e C++. Eles gerenciam assinatura de requisições, timeouts e novas tentativas, além de retornar objetos de resposta estruturados que simplificam o desenvolvimento. Para mais informações, consulte Alibaba Cloud SDKs.
Para verificar as linguagens e dependências compatíveis com o ApsaraDB RDS, acesse o OpenAPI Explorer.
Alibaba Cloud CLI
O Alibaba Cloud CLI permite execute comandos aliyun para interagir com os serviços da Alibaba Cloud e gerenciar recursos na nuvem. Para mais informações, consulte What is Alibaba Cloud CLI?
Para chamar operações de API do ApsaraDB RDS usando o Alibaba Cloud CLI, consulte Generate a command.
ROS
O Resource Orchestration Service (ROS) automatiza a criação e a configuração de recursos em nuvem. Defina sua infraestrutura — incluindo instâncias do Elastic Compute Service (ECS) e do ApsaraDB RDS, bem como o relacionamento entre esses recursos — em um modelo, e o ROS provisionará tudo automaticamente para implementar implantação e O&M automatizados. Para mais informações, consulte What is ROS?
Para conhecer os recursos e tipos de dados do ApsaraDB RDS compatíveis, consulte ApsaraDB RDS resources supported by ROS.
Chamadas de API com encapsulamento personalizado
Para fazer chamadas HTTP nativas, construa as requisições manualmente e assine-as. Para detalhes sobre a assinatura, consulte a Lista de operações por função e Request syntax and signature method V3.
Notas de uso
Se uma operação de API retornar um erro, verifique o código de erro e valide os parâmetros de entrada. Para obter uma lista de códigos de erro, consulte Public error codes.
Para diagnósticos de autoatendimento usando um ID de requisição ou detalhes de erro do SDK, use o Alibaba Cloud OpenAPI Diagnostics.