Ejemplos de integración con la CLI - ApsaraDB for HBase - Centro de documentación de Alibaba Cloud

Alibaba Cloud CLI es una herramienta unificada de línea de comandos basada en OpenAPI Explorer que permite gestionar y mantener ApsaraDB for HBase desde la línea de comandos. Este tema explica cómo invocar operaciones de la API de ApsaraDB for HBase mediante Alibaba Cloud CLI.

Requisitos previos

Antes de empezar, familiarícese con Alibaba Cloud CLI. Para obtener más información, consulte What is Alibaba Cloud CLI?.

Instalación de Alibaba Cloud CLI

Instale Alibaba Cloud CLI en su sistema operativo. Hay instaladores disponibles para Windows, Linux y macOS.

Windows: Install Alibaba Cloud CLI on Windows.
Linux: Install, update, and uninstall Alibaba Cloud CLI.
macOS: Install Alibaba Cloud CLI on macOS.

Como alternativa, puede utilizar Cloud Shell para depurar comandos de Alibaba Cloud CLI sin necesidad de una instalación local. Para obtener más información, consulte What is Cloud Shell?.

Configuración de Alibaba Cloud CLI

Importante

Una cuenta de Alibaba Cloud tiene permisos completos sobre todas las operaciones de la API, lo que representa un alto riesgo de seguridad. Se recomienda utilizar un usuario de RAM para las llamadas a la API y las tareas habituales de operación y mantenimiento.

Antes de usar Alibaba Cloud CLI, configure sus credenciales de identidad y una región predeterminada. Alibaba Cloud CLI admite varios tipos de credenciales. Para obtener más información, consulte Configure and manage identity credentials. En este ejemplo se utiliza un par de AccessKey.

Cree un usuario de RAM y asígnele los permisos necesarios. Para obtener más información, consulte Create a RAM user y Manage RAM user permissions.

Importante
Para este ejemplo, asigne la directiva AliyunHBaseReadOnlyAccess al usuario de RAM. También puede utilizar la directiva AliyunHBaseFullAccess para obtener permisos completos de consulta y modificación, o bien crear una directiva personalizada. Para obtener más información, consulte Create custom RAM authorization policies.
Genere un par de AccessKey para el usuario de RAM y anote el AccessKey ID y el AccessKey Secret. Para obtener más información, consulte Create an AccessKey pair.
Obtenga un ID de región. Alibaba Cloud CLI envía las solicitudes de API a la región especificada. Para consultar la lista de regiones compatibles, véase Request structure.

Nota
Puede agregar la opción --region a un comando para anular la región definida en su archivo de configuración y en las variables de entorno. Para obtener más información, consulte Command-line options.
Configure un perfil con el par de AccessKey del usuario de RAM. En este ejemplo se utiliza el nombre de perfil AkProfile. Para obtener más información, consulte Configure and manage identity credentials.

Generación de un ejemplo de comando de CLI

Vaya a la página de depuración de API de ApsaraDB for HBase en OpenAPI Explorer.
En la página de depuración de API, busque la API deseada en el cuadro de búsqueda de la izquierda. En Parameter Configuration, especifique los parámetros obligatorios y luego haga clic en la pestaña CLI Example para generar un comando de CLI con dichos parámetros.
- Haga clic en el icono para abrir Cloud Shell y depurar el comando.
- Haga clic en el icono para copiar el ejemplo de CLI al portapapeles. Posteriormente, podrá pegarlo en su terminal local y ejecutarlo.
  - Al ejecutar el ejemplo de CLI en su shell local, compruebe el formato de los parámetros. Para obtener más información, consulte Parameter formats.
  - OpenAPI Explorer agrega la opción --region de forma predeterminada, la cual anula la región configurada en su perfil y en las variables de entorno. Elimine o conserve esta opción según sea necesario.

Invocación de operaciones de la API

Estructura de los comandos

Los comandos de Alibaba Cloud CLI utilizan la siguiente sintaxis. Para obtener más información, consulte Generate and run CLI commands.

aliyun <command> <subcommand> [options and parameters]

Opciones comunes de los comandos

Utilice las opciones de línea de comandos para modificar el comportamiento predeterminado o agregar funcionalidades. Las opciones más comunes incluyen:

--profile <profileName>: Ejecuta el comando con el perfil especificado, lo que anula el perfil predeterminado y las variables de entorno.
--help: Muestra información de ayuda para el comando. Para obtener más información, consulte Get help information.

Para obtener más información, consulte Command-line options.

Ejemplo

El siguiente ejemplo invoca la operación DescribeInstance para consultar una instancia específica de ApsaraDB for HBase. Para obtener más información, consulte DescribeInstance.

Ejecute el comando.

aliyun hbase DescribeInstance --region cn-hangzhou --ClusterId 'ld-bp142678b0894****'

Respuesta de ejemplo:

{
        "BackupStatus": "open",
        "ClusterId": "ld-bp142678b0894****",
        "ClusterName": "hbaseue_test",
        "ClusterType": "cluster",
        "ColdStorageSize": 0,
        "ColdStorageStatus": "open",
        "ConfirmMaintainTime": false,
        "CoreDiskCount": 4,
        "CoreDiskSize": 100,
        "CoreDiskType": "cloud_ssd",
        "CoreInstanceType": "hbase.sn2.2xlarge",
        "CoreNodeCount": 4,
        "CreatedTime": "2024-08-06T11:20:36",
        "CreatedTimeUTC": "2024-08-06T03:20:36Z",
        "EnableHbaseProxy": false,
        "EncryptionType": "NoEncryption",
        "Engine": "hbaseue",
        "InstanceId": "ld-bp142678b0894****",
        "InstanceName": "hbaseue_test",
        "IsDeletionProtection": false,
        "IsHa": true,
        "IsLatestVersion": false,
        "IsMultiModel": true,
        "MaintainEndTime": "06:00:00",
        "MaintainStartTime": "02:00:00",
        "MajorVersion": "2.0",
        "MasterDiskSize": 0,
        "MasterDiskType": "",
        "MasterInstanceType": "hbase.sn1.large",
        "MasterNodeCount": 2,
        "ModuleId": 0,
        "ModuleStackVersion": "2.0",
        "NeedUpgrade": false,
        "NeedUpgradeComps": {
                "Comps": []
        },
        "NetworkType": "VPC",
        "PayType": "Postpaid",
        "RegionId": "cn-hangzhou",
        "RequestId": "FBEE6642-D79E-5***-****-C4AF1******",
        "ResourceGroupId": "rg-acfmz7u4zzr****",
        "Status": "ACTIVATION",
        "Tags": {
                "Tag": []
        },
        "TaskProgress": "0",
        "TaskStatus": "running",
        "VpcId": "vpc-bp1ov7as4yvz4kxei****",
        "VswitchId": "vsw-bp1wh6lp1abs3fi0h****",
        "ZoneId": "cn-hangzhou-b"
}