Alibaba Cloud CLI integration example - ApsaraDB RDS - Centro de documentación de Alibaba Cloud

Alibaba Cloud CLI es una herramienta de línea de comandos de propósito general desarrollada con base en API. Úsela para gestionar instancias de RDS desde su shell en lugar de utilizar la consola.

Requisitos previos

Antes de empezar, asegúrese de contar con lo siguiente:

Una cuenta de Alibaba Cloud con acceso a ApsaraDB RDS
Un usuario de RAM con la política AliyunRDSReadOnlyAccess o AliyunRDSFullAccess asociada
Un par de AccessKey (AccessKey ID y AccessKey secret) para dicho usuario de RAM
El ID de la región donde reside su instancia de RDS; consulte Endpoints

El uso de credenciales de la cuenta raíz para invocar operaciones de API implica riesgos de seguridad. Cree un usuario de RAM dedicado para el acceso a la API. Consulte Create a RAM user y Grant permissions to a RAM user .

Instalación de Alibaba Cloud CLI

Instale Alibaba Cloud CLI según su sistema operativo:

Windows: Install Alibaba Cloud CLI on Windows
Linux: Install Alibaba Cloud CLI on Linux
macOS: Install Alibaba Cloud CLI on macOS

Como alternativa, utilice Cloud Shell para ejecutar comandos de Alibaba Cloud CLI directamente en su navegador sin necesidad de una instalación local. Consulte What is Cloud Shell?

Configuración de Alibaba Cloud CLI

Alibaba Cloud CLI admite varios tipos de credenciales. Para la mayoría de los casos de uso, se recomienda comenzar con credenciales de AccessKey.

Tipo de credencial	Cuándo utilizarla	Instrucciones
AccessKey (largo plazo)	Cuentas de servicio y scripts de automatización	Pasos a continuación
Otros tipos de credenciales	Acceso federado o de corta duración	Credential types

Para configurar las credenciales de AccessKey:

Cree un par de AccessKey para su usuario de RAM y registre tanto el AccessKey ID como el AccessKey secret. Consulte Create an AccessKey pair for a RAM user.
Utilice el par de AccessKey para configurar las credenciales de identidad en el perfil de configuración AkProfile. Para obtener más información, consulte Configuration example.
(Opcional) Para ejecutar un comando en una región específica sin modificar su perfil predeterminado, agregue --region <region-id> al final de cualquier comando. Esta opción anula la región definida tanto en el perfil predeterminado como en las variables de entorno. Consulte Command-line options.

Generación de un comando de CLI

Utilice OpenAPI Explorer para construir comandos de CLI de forma interactiva:

Vaya a la página de Debugging de la API de ApsaraDB RDS.
En el cuadro de búsqueda del lado izquierdo, busque la operación de API que desea invocar.
En la pestaña Parameters, introduzca los valores de los parámetros.
Haga clic en la pestaña CLI Example para ver el comando generado con sus parámetros prellenados. Desde la pestaña CLI Example:
- Haga clic en para copiar el comando al portapapeles.
- Haga clic en para abrir Cloud Shell y ejecutar el comando en su navegador.

OpenAPI Explorer agrega --region a los comandos generados de forma predeterminada. Cuando está presente, esta opción anula la configuración de su perfil predeterminado y las variables de entorno. Elimínela o consérvela según su flujo de trabajo. Para conocer los requisitos de formato de parámetros, consulte Parameter formats .

Invocación de operaciones de la API de ApsaraDB RDS

Sintaxis de comandos

Todos los comandos de Alibaba Cloud CLI siguen esta estructura. Consulte Command structure para obtener más detalles.

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

Opciones comunes de comandos

Opción	Descripción
`--profile <profileName>`	Utiliza el perfil de configuración especificado. Anula la configuración de credenciales predeterminada y las variables de entorno.
`--region <regionId>`	Ejecuta el comando en la región especificada. Anula la configuración de credenciales predeterminada y las variables de entorno.
`--help`	Muestra información de ayuda para un comando. Consulte Use the help command.

Para consultar todas las opciones disponibles, véase Command-line options.

Ejemplo 1: Listado de operaciones de API disponibles

Ejecute --help sobre el comando rds para ver todas las operaciones de la API de ApsaraDB RDS:

aliyun rds --help

Salida:

Alibaba Cloud Command Line Interface Version 3.0.216

Usage:
  aliyun rds <ApiName> --parameter1 value1 --parameter2 value2 ...

Product: Rds (ApsaraDB for RDS)
Version: 2014-08-15

Available Api List:
  ActivateMigrationTargetInstance             Switches workloads over from the source PostgreSQL instance to the destination ApsaraDB RDS for PostgreSQL instance.
  AddTagsToResource                           Adds tags to an instance.
  AllocateInstancePublicConnection            Apply for a public endpoint for an ApsaraDB RDS instance
  AllocateReadWriteSplittingConnection        Applies for a read-only routing endpoint for an instance.
  AttachWhitelistTemplateToInstance           Associates a whitelist template with an instance.
  CalculateDBInstanceWeight                   Queries system-assigned read weights.

...

Revise la lista completa en List of operations by function.

Ejemplo 2: Consulta de detalles de una instancia

El siguiente comando invoca DescribeDBInstanceAttribute para recuperar la configuración completa de una instancia de RDS:

aliyun rds DescribeDBInstanceAttribute --region cn-hangzhou --DBInstanceId 'pgm-bp16k272p478****'

Parámetro	Descripción	Ejemplo
`--region`	La región donde reside la instancia	`cn-hangzhou`
`--DBInstanceId`	El ID de la instancia de RDS que se va a consultar	`pgm-bp16k272p478****`

Salida:

{
        "Items": {
                "DBInstanceAttribute": [
                        {
                                "AccountMaxQuantity": 99999,
                                "AccountType": "Mix",
                                "AdvancedFeatures": "LinkedServer,DistributeTransaction",
                                "AutoUpgradeMinorVersion": "Auto",
                                "AvailabilityValue": "100.0%",
                                "BabelfishConfig": {},
                                "CanTempUpgrade": false,
                                "Category": "HighAvailability",
                                "ColdDataEnabled": false,
                                "ConnectionMode": "Standard",
                                "ConnectionString": "pgm-bp16k272p478****.pg.rds.aliyuncs.com",
                                "ConsoleVersion": "2",
                                "CreationTime": "2024-08-06T06:18:48Z",
                                "CurrentKernelVersion": "rds_postgres_1400_20240530",
                                "DBClusterNodes": {
                                        "DBClusterNode": []
                                },
                                "DBInstanceCPU": "2",
                                "DBInstanceClass": "pg.n4.2c.2m",
                                "DBInstanceClassType": "x",
                                "DBInstanceDescription": "DB-test",
                                "DBInstanceDiskUsed": 3520069632,
                                "DBInstanceId": "pgm-bp16k272p478****",
                                "DBInstanceMemory": 8192,
                                "DBInstanceNetType": "Intranet",
                                "DBInstanceStatus": "Running",
                                "DBInstanceStorage": 100,
                                "DBInstanceStorageType": "cloud_essd",
                                "DBInstanceType": "Primary",
                                "DBMaxQuantity": 99999,
                                "DedicatedHostGroupId": "",
                                "DeletionProtection": false,
                                "DispenseMode": "MultiAVZDispenseMode",
                                "Engine": "PostgreSQL",
                                "EngineVersion": "14.0",
                                "ExpireTime": "",
                                "Extra": {
                                        "DBInstanceIds": {
                                                "DBInstanceId": []
                                        }
                                },
                                "IPType": "IPv4",
                                "InsId": 1,
                                "InstanceNetworkType": "VPC",
                                "InstructionSetArch": "x86",
                                "IoAccelerationEnabled": "0",
                                "LatestKernelVersion": "rds_postgres_1400_20240530",
                                "LockMode": "Unlock",
                                "MaintainTime": "18:00Z-22:00Z",
                                "MasterZone": "cn-hangzhou-j",
                                "MaxConnections": 800,
                                "MaxIOMBPS": 0,
                                "MaxIOPS": 6800,
                                "OriginConfiguration": "{\"KindCode\":\"18\"}",
                                "PayType": "Postpaid",
                                "Port": "5432",
                                "ProxyType": 2,
                                "ReadOnlyDBInstanceIds": {
                                        "ReadOnlyDBInstanceId": []
                                },
                                "RegionId": "cn-hangzhou",
                                "ResourceGroupId": "rg-acfmz7u4zzrngoa",
                                "SecurityIPList": "0.0.0.0/0,172.16.0.0/12",
                                "SecurityIPMode": "normal",
                                "ServerlessConfig": {},
                                "SlaveZones": {
                                        "SlaveZone": [
                                                {
                                                        "ZoneId": "cn-hangzhou-k"
                                                }
                                        ]
                                },
                                "SuperPermissionMode": "",
                                "SupportCreateSuperAccount": "Yes",
                                "SupportUpgradeAccountType": "Yes",
                                "Tips": "ok",
                                "TipsLevel": 1,
                                "VSwitchId": "vsw-bp1sxxsodv28ey5dl****",
                                "VpcCloudInstanceId": "pgm-bp16k272p478****-20240806141842",
                                "VpcId": "vpc-bp1ov7as4yvz4kxei****",
                                "ZoneId": "cn-hangzhou-j",
                                "kindCode": "18"
                        }
                ]
        },
        "RequestId": "14B99E32-4ECD-5B8E-A9C8-6738C8C95910"
}

Solución de problemas

Si una llamada a la API devuelve un error, compruebe que los nombres y valores de los parámetros coincidan con la referencia de la API para dicha operación.

Para realizar un diagnóstico de autoservicio, vaya a Alibaba Cloud OpenAPI Diagnostic Platform e introduzca el RequestId de la respuesta de error.

Pasos siguientes

What is Alibaba Cloud CLI? — descripción general completa de funciones
Parameter formats — cómo pasar tipos de parámetros complejos (arreglos JSON, estructuras)
Command-line options — todos los indicadores compatibles y sus reglas de precedencia