Saiba como chamar as APIs do ApsaraDB for ClickHouse usando o OpenAPI Explorer, os SDKs da Alibaba Cloud e outros métodos de integração.
OpenAPI
O OpenAPI Explorer é uma plataforma completa para busca de APIs, documentação, depuração online, exemplos de código em SDK, diagnóstico de erros e estatísticas de chamadas. Utilize-o para chamar e testar APIs em todos os serviços da Alibaba Cloud. O que é a OpenAPI?
Versões
Cada edição de cluster do ApsaraDB for ClickHouse utiliza uma versão diferente da API. Selecione a versão correspondente à sua edição.
|
Número da versão |
Descrição |
|
2019-11-11 |
Utilize esta versão para chamar APIs de clusters da Community-compatible Edition. |
|
2023-05-22 |
Utilize esta versão para chamar APIs de clusters da Enterprise Edition. |
Depuração online
É possível depurar as APIs do ApsaraDB for ClickHouse no OpenAPI Explorer. Antes de realizar chamadas, revise as versões da API, os endpoints e os métodos de integração do ApsaraDB for ClickHouse.
O painel esquerdo lista categorias de API, como Region management, Cluster management e Compute group management. Selecione uma API para visualizar sua descrição, configure parâmetros como ZoneId e RegionId e clique em Initiate Call para testá-la. O painel direito exibe as descrições dos parâmetros e valores de exemplo.
URLs de depuração da API
O ApsaraDB for ClickHouse está disponível nas edições Community-compatible Edition e Enterprise Edition. Cada edição possui uma URL de depuração distinta.
|
Edição |
URL de depuração da API |
|
Community-compatible Edition |
URL de depuração da API para ApsaraDB for ClickHouse Community-compatible Edition |
|
Enterprise Edition |
URL de depuração da API para ApsaraDB for ClickHouse Enterprise Edition |
Endpoints
Para minimizar a latência, selecione um endpoint localizado na mesma região dos seus recursos. Por exemplo, para um cluster do ApsaraDB for ClickHouse na região China (Zhangjiakou), o endpoint público é clickhouse.cn-zhangjiakou.aliyuncs.com e o endpoint de VPC é clickhouse-vpc.cn-zhangjiakou.aliyuncs.com.
Os endpoints públicos são acessíveis globalmente.
-
Os endpoints de VPC operam em uma rede virtual isolada e oferecem os seguintes benefícios:
Maior segurança: acesso restrito ao interior da VPC.
Menor latência: tráfego pela rede interna, sem impacto das flutuações da rede pública.
Custo reduzido: o tráfego interno diminui os custos de transferência de dados.
Todas as regiões e endpoints suportados estão listados em Endpoints de serviço.
Identidades de usuário suportadas
Por padrão, o OpenAPI Explorer utiliza a conta conectada para depuração. Como uma conta da Alibaba Cloud possui permissões totais de API, utilize um usuário RAM com as permissões mínimas necessárias para acesso à API e operações diárias de O&M. Conceda ao usuário RAM as permissões para gerenciar o ApsaraDB for ClickHouse. Autorização do RAM.
|
Identidade |
Suportado |
|
Sim |
|
|
Usuário RAM (Recomendado) |
Sim |
|
Função RAM (Recomendado) |
Sim |
Métodos de integração
O ApsaraDB for ClickHouse suporta diversos métodos de integração: Alibaba Cloud SDK, Terraform, Resource Orchestration Service (ROS) e encapsulamento personalizado.
Os SDKs simplificam a integração e são o método recomendado para chamar a OpenAPI.
|
Método de integração |
Suportado |
|
Alibaba Cloud SDK |
Sim |
|
Alibaba Cloud CLI |
Não suportado |
|
Terraform |
Não suportado |
|
Resource Orchestration Service (ROS) |
Parcialmente suportado |
|
Encapsulamento personalizado |
Sim |
Alibaba Cloud SDK
Os SDKs da Alibaba Cloud suportam Java, C#, Go, Python, Node.js, TypeScript, PHP e C++. Eles gerenciam a autenticação e a assinatura automaticamente, permitindo que você chame as APIs diretamente. Alibaba Cloud SDK.
É possível utilizar um Alibaba Cloud SDK para chamar as APIs do ApsaraDB for ClickHouse. As linguagens suportadas e as etapas de instalação estão disponíveis na Visão geral do SDK do ApsaraDB for ClickHouse.
Alibaba Cloud CLI
O Alibaba Cloud CLI permite gerenciar recursos de nuvem a partir de um shell usando o comando
aliyun. O que é o Alibaba Cloud CLI?.Não é possível usar o Alibaba Cloud CLI para chamar as APIs do ApsaraDB for ClickHouse.
Terraform
O Terraform é uma ferramenta de código aberto para provisionamento e gerenciamento de infraestrutura de nuvem por meio de modelos. O que é o Alibaba Cloud Terraform?.
Não é possível usar o Terraform para orquestrar as APIs do ApsaraDB for ClickHouse.
Resource Orchestration Service (ROS)
O ROS automatiza o provisionamento de recursos de nuvem através de modelos. Defina recursos como instâncias ECS e RDS com suas dependências, e o ROS os criará e configurará automaticamente. O que é o Resource Orchestration Service?.
É viável utilizar o ROS para chamar as APIs do ApsaraDB for ClickHouse. Os tipos de recursos e fontes de dados suportados constam na Lista de recursos do ROS.
Encapsulamento personalizado
Para chamadas HTTP nativas, implemente o algoritmo de assinatura V3 e construa as requisições manualmente. Corpo da requisição e mecanismo de assinatura para V3.
Notas de uso
Se uma chamada de API retornar um erro, verifique os parâmetros da sua requisição na Central de códigos de erro.
Utilize o RequestID ou a mensagem de erro do SDK presente na resposta para diagnosticar problemas na Plataforma de Diagnóstico da OpenAPI da Alibaba Cloud.