O Data Management (DMS) oferece um console visual e acesso programático por meio da depuração online da OpenAPI, do Alibaba Cloud SDK e do Alibaba Cloud CLI. Para desenvolver soluções com eficiência usando o DMS, selecione o método de integração mais adequado às suas necessidades.
Visão geral da OpenAPI
Para facilitar o aprendizado e o uso eficiente da OpenAPI dos produtos em nuvem, a Alibaba Cloud disponibiliza o site da OpenAPI. Essa plataforma completa inclui busca inteligente, documentação, depuração online, acesso a SDKs, exemplos de código, diagnóstico de erros e estatísticas de chamadas. Use o portal da OpenAPI para chamar a OpenAPI de diversos produtos da Alibaba Cloud e visualizar requisições e respostas. O portal também gera automaticamente exemplos de código SDK para acelerar seus primeiros passos com os produtos da Alibaba Cloud. Para mais informações, consulte O que é a OpenAPI?.
Versões da API
A OpenAPI da Alibaba Cloud utiliza números de versão para gerenciar as principais versões de API dos produtos em nuvem.
Por exemplo, o DMS suporta a versão da API 2018-11-01. A string 2018-11-01 é um identificador de versão da API, não uma data. Ela fornece acesso aos recursos mais recentes da API e não indica que a API permaneceu estática desde 2018-11-01.
|
Recurso |
Versão da API |
Descrição |
|
Data Management (DMS) |
Recomendado. |
Depuração online
O DMS oferece depuração de API e outros recursos no portal da OpenAPI. Antes de chamar a API, compreenda as versões, endpoints, estilo da API e métodos de requisição fornecidos pelo DMS.
Na página de depuração do portal da OpenAPI, o painel de navegação à esquerda lista operações de API como ListInstances (recupera uma lista de informações de instâncias), AddInstance, ModifyInstance, GetInstance e DeleteInstance. Após selecionar uma operação de API, configure o endpoint no painel central, como China (Hangzhou), e os parâmetros da requisição. Esses parâmetros incluem Tid (ID do locatário), SearchKey (palavra-chave de busca), DbType (tipo de banco de dados), EnvType (tipo de ambiente), InstanceSource (origem da instância), NetType (tipo de rede), InstanceState (estado da instância) e PageNumber (número da página). Após inserir os valores, clique em Initiate Call para enviar a requisição. O painel de documentação à direita exibe o tipo de dados e um valor de exemplo para cada parâmetro.
Pontos de entrada para depuração
|
Recurso |
Versão da API |
Ponto de entrada |
|
Data Management (DMS) |
Endpoints
DMS
Selecione o endpoint correspondente à região onde seus recursos estão localizados para minimizar a latência.
Por exemplo, o endpoint de VPC para a região China (Zhangjiakou) é dms-enterprise-vpc.cn-zhangjiakou.aliyuncs.com. Para mais informações, consulte Endpoints.
Identidades suportadas
Ao fazer login no site da OpenAPI com sua conta Alibaba Cloud, as chamadas de API durante a depuração online usam essa conta por padrão. Utilizar uma conta Alibaba Cloud para acesso rotineiro à API representa alto risco devido às suas permissões completas. Recomendamos fortemente criar e utilizar um usuário RAM para operações diárias. Conceda permissões ao usuário RAM conforme suas necessidades de negócio antes de efetuar chamadas de API. O usuário RAM deve ter as permissões necessárias para operar o DMS. Para mais informações, consulte Usar o RAM para controle de acesso.
|
Identidade do usuário |
Suportado |
|
Suportado |
|
|
Usuário RAM (recomendado) |
Suportado |
|
Função RAM (recomendado) |
Suportado |
Métodos de integração
Visão geral da integração
O DMS oferece diversos métodos de integração, incluindo SDKs. Escolha o método que melhor atende às necessidades do seu negócio.
Os SDKs são fáceis de integrar e representam o método recomendado para chamar a OpenAPI.
DMS
|
Método |
Suportado |
|
Alibaba Cloud SDK (recomendado) |
Suportado |
|
Suportado |
|
|
Parcialmente suportado |
|
|
Não suportado |
|
|
Encapsulamento personalizado de API (não recomendado) |
Suportado |
Alibaba Cloud SDK
A Alibaba Cloud fornece SDKs para várias linguagens de programação, incluindo Java, C#, Go, Python, Node.js/TypeScript, PHP e C++. Basta integrar o SDK para chamar a OpenAPI diretamente pelos métodos expostos. Os SDKs simplificam o desenvolvimento ao gerenciar a lógica de assinatura, timeout e mecanismos de nova tentativa, além de retornarem objetos Response estruturados. Para mais informações sobre os SDKs da Alibaba Cloud, consulte Alibaba Cloud SDK.
Para detalhes sobre as linguagens e dependências suportadas pelo SDK do DMS, consulte SDK do DMS.
Alibaba Cloud CLI
O Alibaba Cloud CLI permite interagir com os serviços da Alibaba Cloud e gerenciar seus recursos em nuvem a partir de um terminal usando comandos
aliyun. Para mais informações sobre o Alibaba Cloud CLI, consulte O que é o Alibaba Cloud CLI?Use o Alibaba Cloud CLI para chamar operações da API do DMS. Para mais informações, consulte Chamar operações de API RPC usando o Alibaba Cloud CLI.
Resource Orchestration (ROS)
O Resource Orchestration Service (ROS) é um serviço da Alibaba Cloud que simplifica o gerenciamento de recursos em nuvem. Desenvolvedores e administradores podem escrever modelos para definir os recursos necessários da Alibaba Cloud, como instâncias ECS e instâncias de banco de dados RDS, bem como suas dependências. O mecanismo de orquestração do ROS cria e configura automaticamente todos os recursos com base no modelo, permitindo implantação automatizada e O&M. Para mais informações, consulte O que é o Resource Orchestration Service?.
-
Utilize o ROS para orquestrar recursos do DMS. Os seguintes recursos do DMS são suportados:
ALIYUN::DMS::Instance: Registra uma nova instância.
ALIYUN::DMS::User: Registra um novo usuário.
Para utilizar rapidamente o ROS na orquestração de recursos do DMS, consulte Exemplo de integração com ROS.
Encapsulamento personalizado de API
Para realizar chamadas HTTP nativas, implemente o algoritmo de assinatura, construa requisições personalizadas e inicie as chamadas HTTP. Para mais informações sobre o mecanismo de assinatura, consulte Visão geral da API do DMS e Corpo da requisição e mecanismo de assinatura (V3).
Notas de uso
DMS
Caso uma chamada de API falhe, utilize o código de erro retornado para verificar os parâmetros da requisição e seus valores. Para mais informações, consulte Códigos de erro.
Como alternativa, registre o RequestID ou a mensagem de erro do SDK presentes na resposta e use o Diagnóstico da OpenAPI da Alibaba Cloud para solucionar o problema.