alibaba cloud cli rds api examples - ApsaraDB RDS: Central de Documentação do Alibaba Cloud

O Alibaba Cloud CLI é uma ferramenta de linha de comando baseada em OpenAPI. Use-o para gerenciar instâncias do ApsaraDB RDS a partir de um shell. Saiba como instale e configure o CLI e chamar APIs do ApsaraDB RDS.

Pré-requisitos

Novo no Alibaba Cloud CLI? Comece com O que é o Alibaba Cloud CLI?.

Instalar o Alibaba Cloud CLI

Instale o Alibaba Cloud CLI para o seu sistema operacional:

Também é possível depurar comandos CLI no Cloud Shell. O que é o Cloud Shell?

Configurar o Alibaba Cloud CLI

Importante

Sua conta do Alibaba Cloud tem acesso total à API, o que representa um risco de segurança. Crie e utilize um usuário RAM. Atribua AliyunRDSReadOnlyAccess para acesso somente leitura ou AliyunRDSFullAccess para controle total sobre o ApsaraDB RDS.

Configure suas credenciais de identidade, ID de região padrão e outras configurações antes de usar o CLI. O CLI oferece suporte a vários tipos de credenciais (Configurar e gerenciar credenciais de identidade). Este exemplo usa credenciais AccessKey.

Crie um usuário RAM e conceda as permissões de serviço necessárias (Gerencie permissões de usuários RAM).
Crie um par de AccessKey para o usuário RAM. Registre o AccessKey ID e o AccessKey secret para a configuração de credenciais.
Escolha um ID de região. O CLI envia chamadas de API para a região especificada. Regiões disponíveis: Endpoints.

Nota
A opção --region substitui a região padrão definida na configuração de credenciais e nas variáveis de ambiente. Opções de linha de comando.
Configure as credenciais AccessKey em um perfil chamado AkProfile, utilizando o par de AccessKey do usuário RAM. Configurar e gerenciar credenciais de identidade.

Gerar um comando CLI de exemplo

Acesse a Referência de API do ApsaraDB RDS no OpenAPI Explorer.
Pesquise a API na left-side search box. Na aba Parameters, insira os valores obrigatórios. Ao lado da aba Parameters, clique em CLI Example para gerar um comando de exemplo.
- Clique no ícone para abrir o Cloud Shell e depurar o comando.
- Clique no ícone para copiar o exemplo de CLI para a área de transferência e, em seguida, cole-o no shell local para executá-lo.
  - Ao colar um exemplo de CLI no shell local, verifique o formato dos parâmetros. Entender os parâmetros de comando.
  - Por padrão, o OpenAPI Explorer adiciona a opção --region aos comandos de exemplo, substituindo a região definida nas credenciais e nas variáveis de ambiente. Mantenha ou remova essa opção conforme necessário.

Chamar APIs de serviços cloud

Estrutura do comando

Os comandos CLI seguem esta estrutura (Gerar e chamar um comando):

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

Opções comuns de linha de comando

Use as opções de linha de comando para modifique o comportamento dos comandos ou adicionar funcionalidades.

--profile<profileName>: Usa o perfil especificado, substituindo as credenciais padrão e as variáveis de ambiente.
--help: Exibe informações de ajuda para um comando. Obter ajuda.

Opções de linha de comando.

Exemplos

Exemplo 1: Liste as APIs disponíveis do ApsaraDB RDS com --help. Também é possível consultar a visão geral da API.

Execute o comando.
```
aliyun rds --help
```

Visualize a saída do comando.

Command output

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            Applies 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.
...

Exemplo 2: Chame a API DescribeDBInstanceAttribute para consultar os detalhes da instância.

Execute o comando.

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

Visualize a saída do comando.

Command output

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

Nota

Se uma chamada de API falhar, verifique o código de erro para validar os parâmetros da requisição.

Use o ID da requisição ou a mensagem de erro com o Alibaba Cloud OpenAPI Diagnostics para diagnosticar o problema.