Python SDK example for RDS - ApsaraDB RDS - Centro de documentación de Alibaba Cloud

Utilice el SDK de Alibaba Cloud para Python con el fin de invocar la operación DescribeDBInstances de ApsaraDB RDS y obtener una lista de sus instancias de base de datos.

Requisitos previos

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

Python 3 instalado. Ejecute python --version para comprobarlo.
Una cuenta de Alibaba Cloud con un AccessKey ID y un AccessKey secret.
Un usuario de RAM con la directiva AliyunRDSReadOnlyAccess (o superior). Consulte Configurar un usuario de RAM si aún no lo ha hecho.

Configurar un usuario de RAM

Omita esta sección si ya dispone de un usuario de RAM con los permisos necesarios.

Inicie sesión en la consola de RAM, vaya a la página Users y haga clic en Create User.
Establezca Logon Name como rds-openapi-operator y configure Access Mode en Using permanent AccessKey to access.
Haga clic en OK. Guarde el AccessKey ID y el AccessKey secret que se muestran, ya que no podrá recuperarlos posteriormente.
En la página Users, localice al usuario de RAM que acaba de crear y haga clic en Add Permissions dentro de la columna Actions.
Busque AliyunRDS y seleccione AliyunRDSReadOnlyAccess.

AliyunRDSReadOnlyAccess otorga permiso para consultar instancias de RDS. Seleccione AliyunRDSFullAccess para obtener permisos completos de gestión o cree una directiva personalizada. Para más información, consulte Create custom policies .
Haga clic en Grant permissions.

Invocar la API

Paso 1: Revisar la referencia de la API

Antes de invocar una operación de la API, revise sus parámetros y los permisos obligatorios en la referencia de la API de ApsaraDB RDS.

Paso 2: Configurar las variables de entorno

Almacene sus credenciales en variables de entorno para evitar incluir el AccessKey secret en el código fuente y en el control de versiones.

Linux o macOS:

export ALIBABA_CLOUD_ACCESS_KEY_ID=<access_key_id>
export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<access_key_secret>

Windows (Símbolo del sistema):

setx ALIBABA_CLOUD_ACCESS_KEY_ID "<access_key_id>"
setx ALIBABA_CLOUD_ACCESS_KEY_SECRET "<access_key_secret>"

Después de ejecutar setx, reinicie su terminal para que los cambios surtan efecto.

Paso 3: Instalar el SDK

pip install alibabacloud_rds20140815==5.0.1

Paso 4: Descargar y ejecutar el código de ejemplo

Vaya a DescribeDBInstances en OpenAPI Explorer.
En la pestaña Parameters, establezca RegionId como cn-beijing.
En la pestaña SDK Sample Code, seleccione Python y haga clic en Download Project.
Extraiga el paquete y vaya al directorio alibabacloud_sample.

Ejecute el ejemplo:

python sample.py

Si la invocación es exitosa, la respuesta será similar a la siguiente:

{
    "headers": {
        "date": "Tue, 18 Jun 2024 10:12:14 GMT",
        "content-type": "application/json;charset=utf-8",
        "content-length": "1018",
        "connection": "keep-alive",
        "keep-alive": "timeout=25",
        "access-control-allow-origin": "*",
        "access-control-expose-headers": "*",
        "x-acs-request-id": "3BBF9A9B-E74C-5EF5-99BB-4F65B4B67499",
        "x-acs-trace-id": "dcfce27991f7d63647cc3c31ae3daa65",
        "etag": "1se2pACCKd0kse87Rqtbprg8"
    },
    "statusCode": 200,
    "body": {
        "Items": {
            "DBInstance": [
                {
                    "ConnectionMode": "Standard",
                    "ConnectionString": "rm-2zea24972vgw2****.mysql.rds.aliyuncs.com",
                    "CreateTime": "2024-06-18T10:09:56Z",
                    "DBInstanceClass": "mysql.n1e.small.1",
                    "DBInstanceId": "rm-2zea24972vgw2****",
                    "DBInstanceMemory": 1024,
                    "DBInstanceNetType": "Intranet",
                    "DBInstanceStatus": "Creating",
                    "DBInstanceStorageType": "general_essd",
                    "DBInstanceType": "Primary",
                    "DeletionProtection": false,
                    "Engine": "MySQL",
                    "EngineVersion": "8.0",
                    "ExpireTime": "2024-07-18T16:00:00Z",
                    "InstanceNetworkType": "VPC",
                    "LockMode": "Unlock",
                    "MutriORsignle": false,
                    "PayType": "Prepaid",
                    "ReadOnlyDBInstanceIds": {
                        "ReadOnlyDBInstanceId": []
                    },
                    "RegionId": "cn-beijing",
                    "ResourceGroupId": "rg-acfmz7u4zzr****",
                    "TipsLevel": 0,
                    "VSwitchId": "vsw-2zeyawzswr2lno0ys****",
                    "VpcCloudInstanceId": "rm-2zea24972vgw2****-20240618180950",
                    "VpcId": "vpc-2zeev9fov0chw8hjt****",
                    "ZoneId": "cn-beijing-l"
                }
            ]
        },
        "NextToken": "o7PHCFqQhehg8NUW9EJ7Yw",
        "PageNumber": 1,
        "PageRecordCount": 1,
        "RequestId": "3BBF9A9B-E74C-5EF5-99BB-4F65B4B67499",
        "TotalRecordCount": 1
    }
}

Pasos siguientes

Explore otras operaciones de la API de ApsaraDB RDS en el portal de OpenAPI.
Utilice el mismo flujo de trabajo del SDK para invocar operaciones de la API de ApsaraDB RDS en otros lenguajes de programación.