Este tópico descreve os conceitos básicos sobre o uso da OpenAPI do ApsaraDB for HBase.
Visão geral da OpenAPI
A Alibaba Cloud oferece o portal OpenAPI para ajudar você a utilizar a OpenAPI de forma eficiente. Esse portal é uma solução abrangente que integra recursos como busca inteligente de API, documentação, depuração online, obtenção de SDK, exemplos de código, diagnóstico de erros de chamada e estatísticas de chamadas. No portal OpenAPI, é possível chamar as operações da OpenAPI de diversos produtos da Alibaba Cloud e visualizar as requisições e respostas. O portal também gera automaticamente exemplos de código SDK para acelerar o início do desenvolvimento. Para mais informações, consulte O que é OpenAPI.
Versões
A OpenAPI da Alibaba Cloud utiliza números de versão para gerenciar APIs de clusters do ApsaraDB for HBase com diferentes arquiteturas. A seguir estão as versões de API compatíveis com o ApsaraDB for HBase.
|
Versão |
Descrição |
|
2019-01-01 |
Utilize esta versão para chamar operações de API em todos os clusters do ApsaraDB for HBase. |
Depuração online
O ApsaraDB for HBase disponibiliza funcionalidades como depuração de API no Portal OpenAPI. Antes de fazer uma chamada, compreenda informações como versões, descrições de endpoint e métodos de integração fornecidos pelo ApsaraDB for HBase.
Na página do portal OpenAPI, o painel à esquerda contém a árvore de navegação da API com categorias como regiões de serviço, clusters, instâncias, segurança e backups. O painel de depuração fica no centro, onde você pode selecionar um endereço de serviço, configurar parâmetros de requisição como AcceptLanguage e Engine e, em seguida, clicar em Initiate Call. O painel à direita exibe a documentação, incluindo descrições dos parâmetros de requisição e resposta, além de exemplos de SDK e CLI.
Portal de depuração
Para acessar o portal de depuração de API do ApsaraDB for HBase, consulte Portal de Depuração de API.
Endpoints
Para minimizar a latência, selecione um endpoint na mesma região dos seus recursos. Por exemplo, o endpoint de VPC na região China (Qingdao) é hbase.aliyuncs.com.
Os endpoints públicos são acessíveis globalmente.
-
Uma Virtual Private Cloud (VPC) é uma rede virtual isolada. As vantagens de usar um endpoint de VPC incluem:
Maior segurança: os endpoints de VPC são acessíveis apenas dentro de uma VPC, oferecendo proteção reforçada.
Tempos de resposta mais rápidos: os endpoints de VPC operam na rede interna da VPC, o que geralmente resulta em respostas mais ágeis e evita a latência da rede pública.
Custos reduzidos: os endpoints de VPC utilizam comunicação via rede interna.
Para mais informações, consulte estrutura da requisição.
Identidades de usuário
Ao fazer login no portal OpenAPI, o sistema utiliza sua conta atual para depuração online por padrão. Como uma conta Alibaba Cloud possui permissões para acessar todas as APIs, usá-la para depuração representa um alto risco de segurança. Recomendamos que você não utilize sua conta Alibaba Cloud para depuração online. Crie e utilize um usuário RAM para acesso à API e operações diárias de O&M. Antes de chamar operações de API, conceda ao usuário RAM apenas as permissões necessárias. O usuário RAM deve ter permissão para gerenciar o ApsaraDB for HBase. Para mais informações, consulte Criar políticas de autorização RAM personalizadas.
|
Identidade de usuário |
Compatível |
|
Compatível |
|
|
Usuário RAM (Recomendado) |
Compatível |
|
Função RAM (Recomendado) |
Compatível |
Métodos de integração
O ApsaraDB for HBase oferece múltiplos métodos de integração, incluindo SDKs da Alibaba Cloud e encapsulamento personalizado. Escolha o método que melhor atende às necessidades do seu negócio.
Os SDKs são fáceis de integrar e representam a forma recomendada de chamar operações da OpenAPI.
|
Método de integração |
Compatível |
|
Alibaba Cloud SDK |
Compatível |
|
Alibaba Cloud CLI |
Compatível |
|
Terraform |
Compatível |
|
Resource Orchestration Service (ROS) |
Compatível |
|
Encapsulamento personalizado |
Compatível |
Alibaba Cloud SDK
A Alibaba Cloud fornece SDKs em diversas linguagens de programação, como Java, C#, Go, Python, PHP e C++. Esses SDKs lidam com os detalhes subjacentes das chamadas de API, como identidade, autenticação e regras de assinatura. Basta integrar um SDK para chamar diretamente as operações da OpenAPI. Para mais informações sobre os SDKs da Alibaba Cloud, consulte Alibaba Cloud SDK.
Utilize os SDKs da Alibaba Cloud para chamar as operações da OpenAPI do ApsaraDB for HBase. Para ver as linguagens compatíveis e instruções de instalação, consulte Instalar SDKs.
Alibaba Cloud CLI
O Alibaba Cloud CLI é uma ferramenta de linha de comando que permite gerenciar seus serviços e recursos da Alibaba Cloud com o comando
aliyun. Para mais informações, consulte O que é Alibaba Cloud CLI.Use o Alibaba Cloud CLI para chamar as operações da OpenAPI do ApsaraDB for HBase. Para mais informações, consulte Chamar uma API RPC.
Resource Orchestration Service (ROS)
O Resource Orchestration Service (ROS) é um serviço da Alibaba Cloud que simplifica o gerenciamento de recursos de nuvem. Escreva 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 do ROS cria e configura automaticamente todos os recursos com base no modelo, permitindo implantação e O&M automatizados. Para mais informações, consulte O que é Resource Orchestration Service.
Empregue o ROS para orquestrar e chamar recursos do ApsaraDB for HBase. Para obter uma lista de recursos e fontes de dados compatíveis, consulte Recursos compatíveis com o ROS.
Encapsulamento personalizado
Crie requisições com encapsulamento personalizado para acessar a OpenAPI da Alibaba Cloud seguindo a documentação de assinatura V3 para SDKs. Para chamadas HTTP nativas, implemente o algoritmo de assinatura, construa as requisições e envie-as. Para mais detalhes sobre o mecanismo de assinatura, consulte Corpo da requisição V3 e mecanismo de assinatura.
Observações
Se uma chamada de API retornar um erro, consulte o código de erro retornado para verificar os parâmetros e valores da sua requisição. Para mais informações, acesse Central de Códigos de Erro.
Registre o RequestID ou a mensagem de erro do SDK presente na resposta e utilize a Plataforma de Diagnóstico da OpenAPI da Alibaba Cloud para diagnósticos de autoatendimento.