Este tema describe los conceptos básicos para usar la openapi de ApsaraDB for HBase.
Descripción general de openapi
Alibaba Cloud ofrece el portal de openapi para ayudarle a utilizarla de manera eficiente. Este portal es un producto integral que integra funciones como búsqueda inteligente de API, documentación, depuración en línea, obtención de SDK, ejemplos de código, diagnóstico de errores de llamadas y estadísticas de llamadas. En el portal de openapi, puede llamar a las operaciones de openapi de diversos productos de Alibaba Cloud y consultar las solicitudes y respuestas. El portal también genera automáticamente ejemplos de código de SDK para que pueda comenzar rápidamente. Para obtener más información, consulte What is OpenAPI.
Versiones
La openapi de Alibaba Cloud utiliza números de versión para gestionar las API de los clústeres de ApsaraDB for HBase con distintas arquitecturas. A continuación se muestran las versiones de API que admite ApsaraDB for HBase.
|
Versión |
Descripción |
|
2019-01-01 |
Utilice esta versión para llamar a las operaciones de API de todos los clústeres de ApsaraDB for HBase. |
Depuración en línea
ApsaraDB for HBase proporciona funciones como la depuración de API en el portal de openapi. Antes de hacer una llamada, debe conocer información como las versiones, las descripciones de los endpoint y los métodos de integración que ofrece ApsaraDB for HBase.
En la página del portal de openapi, el panel izquierdo contiene el árbol de navegación de API con categorías como regiones de servicio, clústeres, instancias, seguridad y copias de seguridad. El panel de depuración se encuentra en el centro; ahí puede seleccionar una dirección de servicio, configurar parámetros de solicitud como AcceptLanguage y Engine, y luego hacer clic en Initiate Call. El panel derecho muestra la documentación, incluidas las descripciones de los parámetros de solicitud y respuesta, así como ejemplos de SDK y CLI.
Portal de depuración
Para acceder al portal de depuración de API de ApsaraDB for HBase, consulte Portal de depuración de API.
Endpoint
Para minimizar la latencia, seleccione un endpoint en la misma región que sus recursos. Por ejemplo, el endpoint de VPC en la región China (Qingdao) es hbase.aliyuncs.com.
Los endpoint públicos son accesibles a nivel global.
-
Una Virtual Private Cloud (VPC) es una red virtual aislada. Las ventajas de usar un endpoint de VPC son:
Mayor seguridad: los endpoint de VPC solo son accesibles dentro de una VPC, lo que proporciona seguridad mejorada.
Tiempos de respuesta más rápidos: los endpoint de VPC operan dentro de una red interna de VPC. Esto generalmente produce respuestas más rápidas y evita la latencia de la red pública.
Menores costos: los endpoint de VPC utilizan comunicación por red interna.
Para obtener más información, consulte request structure.
Identidades de usuario
Cuando inicia sesión en el portal de openapi, este utiliza su cuenta actual para la depuración en línea de forma predeterminada. Dado que una cuenta de Alibaba Cloud tiene permisos para acceder a todas las API, usarla para depurar representa un riesgo de seguridad alto. Se recomienda no utilizar su cuenta de Alibaba Cloud para la depuración en línea. Cree y utilice un usuario de RAM para el acceso a las API y las tareas diarias de operación y mantenimiento. Antes de llamar a las operaciones de API, otorgue al usuario de RAM únicamente los permisos obligatorios. El usuario de RAM debe tener permiso para gestionar ApsaraDB for HBase. Para obtener más información, consulte Create custom RAM authorization policies.
|
Identidad de usuario |
Compatible |
|
Compatible |
|
|
RAM user (Recomendado) |
Compatible |
|
RAM role (Recomendado) |
Compatible |
Métodos de integración
ApsaraDB for HBase ofrece varios métodos de integración, incluidos los SDK de Alibaba Cloud y la encapsulación personalizada. Elija el método que mejor se adapte a las necesidades de su negocio.
Los SDK son fáciles de integrar y constituyen la forma recomendada de llamar a las operaciones de openapi.
|
Método de integración |
Compatible |
|
SDK de Alibaba Cloud |
Compatible |
|
CLI de Alibaba Cloud |
Compatible |
|
Terraform |
Compatible |
|
Resource Orchestration Service (ROS) |
Compatible |
|
Encapsulación personalizada |
Compatible |
SDK de Alibaba Cloud
Alibaba Cloud proporciona SDK en diversos lenguajes de programación, como Java, C#, Go, Python, PHP y C++. Estos SDK gestionan los detalles subyacentes de las llamadas a las API, como la identidad, la autenticación y las reglas de firma. Solo necesita integrar un SDK para llamar directamente a las operaciones de openapi. Para obtener más información sobre los SDK de Alibaba Cloud, consulte Alibaba Cloud SDK.
Puede usar los SDK de Alibaba Cloud para llamar a las operaciones de openapi de ApsaraDB for HBase. Para consultar los lenguajes compatibles y las instrucciones de instalación, visite Instalar SDK.
CLI de Alibaba Cloud
El CLI de Alibaba Cloud es una herramienta de línea de comandos que le permite gestionar sus servicios y recursos de Alibaba Cloud mediante el comando
aliyun. Para obtener más información, consulte What is Alibaba Cloud CLI.Puede usar el CLI de Alibaba Cloud para llamar a las operaciones de openapi de ApsaraDB for HBase. Para obtener más información, consulte Call an RPC API.
Resource Orchestration Service (ROS)
Resource Orchestration Service (ROS) es un servicio de Alibaba Cloud que simplifica la gestión de recursos en la nube. Puede escribir plantillas para definir los recursos de Alibaba Cloud que necesita, como instancias de ECS e instancias de base de datos de RDS, junto con sus dependencias. Después, el motor de ROS crea y configura automáticamente todos los recursos según la plantilla, lo que habilita el despliegue y las operaciones y mantenimiento automatizados. Para obtener más información, consulte What is Resource Orchestration Service.
Puede usar ROS para orquestar y llamar a los recursos de ApsaraDB for HBase. Para consultar la lista de recursos y fuentes de datos compatibles, vea Resources supported by ROS.
Encapsulación personalizada
Puede crear solicitudes encapsuladas personalizadas para acceder a la openapi de Alibaba Cloud si sigue la documentación de firmas V3 para SDK. En el caso de llamadas HTTP nativas, debe implementar el algoritmo de firma, construir las solicitudes y luego enviarlas. Para obtener más detalles sobre el mecanismo de firma, consulte V3 request body and signature mechanism.
Notas
Si una llamada a la API devuelve un error, consulte el código de error devuelto para comprobar los parámetros y valores de su solicitud. Para obtener más información, visite Centro de códigos de error.
También puede registrar el RequestID o el mensaje de error del SDK de la respuesta y utilizar la Plataforma de diagnóstico de openapi de Alibaba Cloud para ejecutar diagnósticos de autoservicio.