Exemple de SDK Python pour RDS - ApsaraDB RDS - Centre de documentation Alibaba Cloud

Utilisez le SDK Alibaba Cloud pour Python afin d'appeler l'opération DescribeDBInstances d'ApsaraDB RDS et de lister vos instances de base de données.

Prérequis

Avant de commencer, vérifiez que vous disposez des éléments suivants :

Python 3 installé. Exécutez python --version pour vérifier la version.
Un compte Alibaba Cloud associé à un ID AccessKey et un secret AccessKey.
Un utilisateur RAM disposant de la politique AliyunRDSReadOnlyAccess (ou d'un niveau supérieur). Si ce n'est pas encore fait, consultez la section Configurer un utilisateur RAM.

Configurer un utilisateur RAM

Ignorez cette section si vous disposez déjà d'un utilisateur RAM avec les autorisations requises.

Connectez-vous à la console RAM, accédez à la page Users, puis cliquez sur Create User.
Définissez Logon Name sur rds-openapi-operator et Access Mode sur Using permanent AccessKey to access.
Cliquez sur OK. Enregistrez l'ID AccessKey et le secret AccessKey affichés ; ils ne seront plus consultables par la suite.
Sur la page Users, localisez l'utilisateur RAM que vous venez de créer et cliquez sur Add Permissions dans la colonne Actions.
Recherchez AliyunRDS et sélectionnez AliyunRDSReadOnlyAccess.

AliyunRDSReadOnlyAccess accorde l'autorisation d'interroger les instances RDS. Sélectionnez AliyunRDSFullAccess pour obtenir des autorisations de gestion complètes, ou créez une politique personnalisée. Pour plus d'informations, consultez Créer des politiques personnalisées .
Cliquez sur Grant permissions.

Appeler l'API

Étape 1 : Consulter la référence de l'API

Avant d'appeler une opération d'API, examinez ses paramètres et les autorisations requises dans la référence de l'API ApsaraDB RDS.

Étape 2 : Configurer les variables d'environnement

Stockez vos identifiants dans des variables d'environnement pour éviter d'exposer votre secret AccessKey dans le code source et le contrôle de version.

Linux ou macOS :

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

Windows (Invite de commandes) :

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

Après avoir exécuté setx, redémarrez votre terminal pour appliquer les modifications.

Étape 3 : Installer le SDK

pip install alibabacloud_rds20140815==5.0.1

Étape 4 : Télécharger et exécuter l'exemple de code

Accédez à DescribeDBInstances sur OpenAPI Explorer.
Dans l'onglet Parameters, définissez RegionId sur cn-beijing.
Dans l'onglet SDK Sample Code, sélectionnez Python et cliquez sur Download Project.
Extrayez le package et accédez au répertoire alibabacloud_sample.

Exécutez l'exemple :

python sample.py

Si l'appel aboutit, la réponse ressemble à ceci :

{
    "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
    }
}

Étapes suivantes

Explorez d'autres opérations d'API ApsaraDB RDS sur le portail OpenAPI.
Utilisez le même flux de travail SDK pour appeler les opérations d'API ApsaraDB RDS dans d'autres langages de programmation.