ApsaraDB RDS Python SDK call example - ApsaraDB RDS: Central de Documentação do Alibaba Cloud

Utilize o Alibaba Cloud SDK for Python para invocar a operação DescribeDBInstances e consultar instâncias do ApsaraDB RDS.

Antes de começar

Antes de chamar uma operação de API, consulte a visão geral da API para entender os parâmetros e as permissões necessários.

Criar um usuário RAM e conceder permissões

Caso já possua um usuário RAM com as permissões necessárias, ignore esta seção.

Crie um usuário RAM:
1. No console do RAM, acesse a página Users e clique em Create User.
2. Defina o campo Logon Name como rds-openapi-operator e selecione Programmatic Access no campo Access Method.
3. Clique em OK e salve o AccessKey ID e o AccessKey Secret do novo usuário RAM.
Conceda permissões ao usuário RAM:
1. Na página Users, localize o usuário RAM desejado e clique em Add Permissions na coluna Actions.
2. Insira AliyunRDS na caixa de pesquisa e selecione a política AliyunRDSReadOnlyAccess.
  
  Nota
  A política AliyunRDSReadOnlyAccess concede acesso somente leitura às instâncias do ApsaraDB RDS. Para obter acesso total, selecione AliyunRDSFullAccess. Também é possível criar uma política personalizada.
3. Clique em OK.

Chamar a API

Os passos a seguir utilizam Python como exemplo. Para outras linguagens, baixe o SDK na página do SDK do ApsaraDB RDS.

Preparar o ambiente Python

Baixe e instale o Python 3. Para verificar uma instalação existente, execute o comando python --version.

Configurar variáveis de ambiente

Defina as variáveis de ambiente ALIBABA_CLOUD_ACCESS_KEY_ID e ALIBABA_CLOUD_ACCESS_KEY_SECRET.

Em sistemas Linux e macOS, substitua <access_key_id> e <access_key_secret> pelos seus valores reais e execute os comandos abaixo:
```
export ALIBABA_CLOUD_ACCESS_KEY_ID=<access_key_id>
export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<access_key_secret>
```
No Windows, crie as variáveis de ambiente ALIBABA_CLOUD_ACCESS_KEY_ID e ALIBABA_CLOUD_ACCESS_KEY_SECRET com os valores do seu par de AccessKey e reinicie o sistema.

Instalar dependências

Execute o seguinte comando para instalar o SDK:

pip install alibabacloud_rds20140815==5.0.1

Baixar o código de exemplo

No OpenAPI Explorer, acesse a página DescribeDBInstances.
Na aba Parameter Configuration, configure os parâmetros. Neste exemplo, defina RegionId como cn-beijing.
No painel à direita, dentro da aba SDK Sample, selecione Python e clique em Download Project.
Extraia o pacote baixado e navegue até o diretório alibabacloud_sample.

Executar o código

Execute o seguinte comando:

python sample.py

Exemplo de resposta:

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