Aprenda a invocar las API de ApsaraDB for ClickHouse mediante OpenAPI Explorer, los SDK de Alibaba Cloud y otros métodos de integración.
OpenAPI
OpenAPI Explorer es una plataforma integral que permite buscar API, consultar documentación, depurar en línea, obtener ejemplos de código para SDK, diagnosticar errores y visualizar estadísticas de llamadas. Úsela para invocar y probar API en todos los servicios de Alibaba Cloud. What is OpenAPI?
Versiones
Cada edición de clúster de ApsaraDB for ClickHouse utiliza una versión distinta de la API. Seleccione la versión correspondiente a su edición.
|
Número de versión |
Descripción |
|
2019-11-11 |
Utilice esta versión para invocar las API de clústeres Community-compatible Edition. |
|
2023-05-22 |
Utilice esta versión para invocar las API de clústeres Enterprise Edition. |
Depuración en línea
Puede depurar las API de ApsaraDB for ClickHouse en OpenAPI Explorer. Antes de realizar llamadas, revise las versiones de API, los endpoints y los métodos de integración disponibles para ApsaraDB for ClickHouse.
El panel izquierdo muestra categorías de API como Region management, Cluster management y Compute group management. Seleccione una API para consultar su descripción, configurar parámetros como ZoneId y RegionId, y haga clic en Initiate Call para probarla. El panel derecho presenta las descripciones de los parámetros junto con valores de ejemplo.
URL de depuración de API
ApsaraDB for ClickHouse está disponible en Community-compatible Edition y Enterprise Edition. Cada edición cuenta con una URL de depuración independiente.
|
Edición |
URL de depuración de API |
|
Community-compatible Edition |
URL de depuración de API para ApsaraDB for ClickHouse Community-compatible Edition |
|
Enterprise Edition |
URL de depuración de API para ApsaraDB for ClickHouse Enterprise Edition |
Endpoints
Para minimizar la latencia, seleccione un endpoint ubicado en la misma región que sus recursos. Por ejemplo, para un clúster de ApsaraDB for ClickHouse en la región China (Zhangjiakou), el endpoint público es clickhouse.cn-zhangjiakou.aliyuncs.com y el endpoint de VPC es clickhouse-vpc.cn-zhangjiakou.aliyuncs.com.
Los endpoints públicos son accesibles globalmente.
-
Los endpoints de VPC operan sobre una red virtual aislada y ofrecen las siguientes ventajas:
Mayor seguridad: solo se puede acceder desde dentro de la VPC.
Menor latencia: al usar la red interna, no les afectan las fluctuaciones de la red pública.
Menor costo: el tráfico interno reduce los gastos por transferencia de datos.
Todas las regiones y endpoints compatibles se enumeran en Service endpoints.
Identidades de usuario compatibles
De forma predeterminada, OpenAPI Explorer utiliza la cuenta con la que inició sesión para la depuración. Dado que una cuenta de Alibaba Cloud posee permisos completos sobre las API, se recomienda emplear un usuario de RAM con los permisos mínimos necesarios para el acceso a las API y las tareas diarias de operación y mantenimiento. Otorgue al usuario de RAM los permisos para gestionar ApsaraDB for ClickHouse. RAM authorization.
|
Identidad |
Compatible |
|
Sí |
|
|
RAM user (Recomendado) |
Sí |
|
RAM role (Recomendado) |
Sí |
Métodos de integración
ApsaraDB for ClickHouse admite varios métodos de integración: SDK de Alibaba Cloud, Terraform, Resource Orchestration Service (ROS) y encapsulación personalizada.
Los SDK simplifican la integración y constituyen el método recomendado para invocar OpenAPI.
|
Método de integración |
Compatible |
|
Alibaba Cloud SDK |
Sí |
|
Alibaba Cloud CLI |
No compatible |
|
Terraform |
No compatible |
|
Resource Orchestration Service (ROS) |
Parcialmente compatible |
|
Encapsulación personalizada |
Sí |
Alibaba Cloud SDK
Los SDK de Alibaba Cloud son compatibles con Java, C#, Go, Python, Node.js, TypeScript, PHP y C++. Estos SDK gestionan la autenticación y la firma de solicitudes, lo que le permite invocar las API directamente. Alibaba Cloud SDK.
Sí puede utilizar un SDK de Alibaba Cloud para invocar las API de ApsaraDB for ClickHouse. Los lenguajes compatibles y los pasos de instalación se detallan en ApsaraDB for ClickHouse SDK overview.
Alibaba Cloud CLI
Alibaba Cloud CLI le permite gestionar recursos en la nube desde un shell mediante el comando
aliyun. What is Alibaba Cloud CLI?.No puede utilizar Alibaba Cloud CLI para invocar las API de ApsaraDB for ClickHouse.
Terraform
Terraform es una herramienta de código abierto diseñada para aprovisionar y gestionar infraestructura en la nube mediante plantillas. What is Alibaba Cloud Terraform?.
No puede utilizar Terraform para orquestar las API de ApsaraDB for ClickHouse.
Resource Orchestration Service (ROS)
ROS automatiza el aprovisionamiento de recursos en la nube a través de plantillas. Defina recursos como instancias ECS e instancias RDS junto con sus dependencias, y ROS los creará y configurará automáticamente. What is Resource Orchestration Service?.
Sí puede utilizar ROS para invocar las API de ApsaraDB for ClickHouse. Los tipos de recursos y orígenes de datos compatibles se enumeran en ROS resource list.
Encapsulación personalizada
Para llamadas HTTP nativas, implemente el algoritmo de firma V3 y construya las solicitudes manualmente. Request body and signing mechanism for V3.
Notas de uso
Si una llamada a la API devuelve un error, compruebe los parámetros de su solicitud en el Centro de códigos de error.
Utilice el RequestID o el mensaje de error del SDK incluido en la respuesta para diagnosticar problemas en la Plataforma de diagnóstico de OpenAPI de Alibaba Cloud.