Este tópico descreve informações básicas e observações importantes sobre o uso do OpenAPI do Lindorm.
OpenAPI
A Alibaba Cloud oferece o portal OpenAPI para facilitar o aprendizado e o uso rápido das APIs dos products cloud. Esse portal é uma solução completa com recursos como busca inteligente de API, documentação, depuração online, acesso a SDK, exemplos de código, diagnóstico de erros e estatísticas de chamadas. Com ele, você chama APIs de diversos products da Alibaba Cloud, visualiza requisições e respostas e gera automaticamente códigos de exemplo em SDK para acelerar a integração. Para mais informações, consulte What is OpenAPI?.
Versões
O OpenAPI da Alibaba Cloud utiliza números de versão para gerenciar as APIs de clusters do Lindorm com diferentes arquiteturas. A seguir estão as versões de API compatíveis com o Lindorm e suas respectivas descrições.
|
Versão |
Descrição |
|
2020-06-15 |
Todas as instâncias do Lindorm utilizam este número de versão para chamar a API. |
Depuração online
O Lindorm disponibiliza funcionalidades como depuração de API no Portal OpenAPI. Antes de chamar uma API, compreenda a versão, a descrição do endpoint e o método de integração do Lindorm. Faça login no OpenAPI Portal. No painel de navegação à esquerda, selecione a versão da API 2020-06-15. Na categoria de região, escolha a API DescribeRegions para obter todas as regiões compatíveis com o Lindorm. Na lista suspensa Service Address, selecione uma região de destino, como China (Hangzhou). Na seção de configuração de parâmetros, defina o parâmetro AcceptLanguage (string, valor de exemplo: zh-CN). Os parâmetros de resposta incluem RequestId (string) e Regions (uma lista de regiões). Após concluir as configurações, clique em Initiate Call.
Portal de depuração
O API Explorer do Lindorm está disponível em API Explorer.
Endpoints
Escolha o endpoint na região onde seus recursos estão localizados para obter menor latência. Por exemplo, o endpoint de VPC para a região China (Qingdao) é hitsdb-vpc.cn-qingdao.aliyuncs.com.
Os endpoints públicos têm acesso global.
-
Uma Virtual Private Cloud (VPC) é uma rede virtual isolada. Os endpoints de VPC oferecem os seguintes benefícios:
Alta segurança: como os endpoints de VPC são acessíveis apenas dentro de uma VPC, eles proporcionam maior segurança e privacidade.
Resposta mais rápida: ao utilizar uma rede interna, os endpoints de VPC oferecem tempos de resposta menores que os endpoints públicos, sem sofrer com latência ou limites de largura de banda da rede pública.
Custos reduzidos: o uso de endpoints de VPC diminui os custos de transferência de dados, pois a comunicação ocorre por uma rede interna.
proporcionam maior segurança e privacidade.
Resposta mais rápida: ao utilizar uma rede interna, os endpoints de VPC oferecem tempos de resposta menores que os endpoints públicos, sem sofrer com latência ou limites de largura de banda da rede pública.
Custos reduzidos: o uso de endpoints de VPC diminui os custos de transferência de dados, pois a comunicação ocorre por uma rede interna.
Para mais informações, consulte Endpoints.
Identidades de usuário compatíveis
Ao fazer login no site do OpenAPI, o sistema utiliza por padrão a conta conectada para depuração online de API. Uma conta da Alibaba Cloud tem permissão para acessar todas as APIs, o que representa um alto risco de segurança. Por isso, não recomendamos o uso de uma conta da Alibaba Cloud para depurar APIs online. Recomendamos fortemente crie e utilizar um usuário RAM para acesso à API ou operações diárias. Conceda permissões ao usuário RAM conforme necessário, de acordo com seus requisitos de negócio, antes de realizar chamadas de API. O usuário RAM deve ter permissões para operar o Lindorm. Para mais informações, consulte Authorization Information.
|
Identidade de usuário |
Compatível |
|
Sim |
|
|
RAM user (recomendado) |
Sim |
|
RAM role (recomendado) |
Sim |
Métodos de integração
O Lindorm oferece diversos métodos de integração, como o SDK da Alibaba Cloud e wrappers personalizados. Selecione a opção que melhor atende às necessidades do seu negócio.
Os SDKs simplificam a integração e são a forma recomendada para chamar operações do OpenAPI.
|
Método de integração |
Compatível |
|
SDK da Alibaba Cloud |
Sim |
|
CLI da Alibaba Cloud |
Sim |
|
Terraform |
Sim |
|
Resource Orchestration Service (ROS) |
Sim |
|
Encapsulamento personalizado |
Sim |
SDK da Alibaba Cloud
A Alibaba Cloud fornece SDKs para várias linguagens de programação, incluindo Java, C#, Go, Python, PHP e C++. Os SDKs abstraem os detalhes de implementação do OpenAPI e padronizam as regras de identidade, autenticação e assinatura. Basta integrar um SDK para chamar operações do OpenAPI diretamente. Para mais informações sobre os SDKs da Alibaba Cloud, consulte Alibaba Cloud SDK. Para mais informações sobre os SDKs da Alibaba Cloud, consulte Alibaba Cloud SDK.
Utilize o SDK da Alibaba Cloud para chamar o OpenAPI do Lindorm. Para consultar as linguagens compatíveis e os métodos de instalação de dependências, veja Instalação do SDK.tab=primer-doc" id="c5b490c8ffhez">Instalação do SDK Instalação do SDK.
CLI da Alibaba Cloud
A CLI da Alibaba Cloud é uma ferramenta de linha de comando que permite interagir com os services da Alibaba Cloud e gerencie seus recursos cloud usando o comando
aliyunem um shell de linha de comando. Para mais informações sobre a CLI da Alibaba Cloud, consulte What is Alibaba Cloud CLI?. Consulte What is Alibaba Cloud CLI?.Use a CLI da Alibaba Cloud para chamar o OpenAPI do Lindorm. Para mais informações, consulte Call RPC APIs. Consulte Call RPC APIs.
Resource Orchestration Service (ROS)
O Resource Orchestration Service (ROS) é um service da Alibaba Cloud que simplifica o gerenciamento de recursos cloud. Crie 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 configure automaticamente todos os recursos com base no modelo, permitindo implantação e O&M automatizados. Para mais informações, consulte What is ROS?. Para mais informações, consulte What is ROS?.
Use o Resource Orchestration Service (ROS) para orquestrar o Lindorm. Para obter uma lista de recursos padrão e de dados compatíveis, consulte Resource Orchestration List. Para obter uma lista de recursos padrão e de dados compatíveis, consulte Resource Orchestration List.
Encapsulamento personalizado
Alternativamente, construa seu próprio wrapper de requisição para acessar o OpenAPI da Alibaba Cloud. Esse método exige a implementação do algoritmo de assinatura V3, a construção de uma requisição personalizada e o envio via HTTP. Para mais informações sobre o mecanismo de assinatura, consulte V3 request body & signing mechanism.
Observações de uso
Se uma chamada de API retornar um erro, verifique o código de erro retornado e revise os parâmetros da requisição e seus valores. Para mais informações, consulte Central de Códigos de Erro.
Registre também o RequestID retornado ou a mensagem de erro do SDK e utilize a Plataforma de Diagnóstico do OpenAPI da Alibaba Cloud para diagnosticar o problema.