A Alibaba Cloud CLI é uma ferramenta de linha de comando de uso geral baseada em APIs. Use-a para gerenciar instâncias do RDS diretamente do shell, sem precisar acessar o console.
Pré-requisitos
Antes de começar, verifique se você tem:
Uma conta Alibaba Cloud com acesso ao ApsaraDB RDS
-
Um usuário RAM com a política AliyunRDSReadOnlyAccess ou AliyunRDSFullAccess anexada
Um par de AccessKey (AccessKey ID e AccessKey secret) para esse usuário RAM
O ID da região onde sua instância RDS está localizada — consulte Endpoints
O uso de credenciais da conta raiz para chamar operações de API apresenta riscos de segurança. Crie um usuário RAM dedicado para acesso à API. Consulte Create a RAM user e Grant permissions to a RAM user .
Instale a Alibaba Cloud CLI
Instale a Alibaba Cloud CLI conforme seu sistema operacional:
Windows: Install Alibaba Cloud CLI on Windows
Como alternativa, use o Cloud Shell para executar comandos da Alibaba Cloud CLI diretamente no navegador, sem instalação local. Consulte What is Cloud Shell?
Configure a Alibaba Cloud CLI
A Alibaba Cloud CLI oferece suporte a diversos tipos de credenciais. Na maioria dos casos, comece pelas credenciais AccessKey.
|
Tipo de credencial |
Quando usar |
Instruções |
|
AccessKey (longo prazo) |
Contas de service e scripts de automação |
Etapas abaixo |
|
Outros tipos de credenciais |
Acesso federado ou de curta duração |
Para configurar as credenciais AccessKey:
Crie um par de AccessKey para seu usuário RAM e anote o AccessKey ID e o AccessKey secret. Consulte Create an AccessKey pair for a RAM user.
Use o par de AccessKey para configurar as credenciais de identidade no perfil
AkProfile. Para mais detalhes, veja Exemplo de configuração.(Opcional) Para executar um comando em uma região específica sem alterar o perfil padrão, adicione
--region <region-id>ao final do comando. Essa opção substitui a região definida no perfil padrão e nas variáveis de ambiente. Consulte Command-line options.
Gerar um comando CLI
Use o OpenAPI Explorer para criar comandos CLI interativamente:
Acesse a página de Depuração da API do ApsaraDB RDS.
Na caixa de pesquisa à esquerda, busque a operação de API desejada.
Na aba Parameters, preencha os valores dos parâmetros.
-
Clique na aba CLI Example para visualizar o comando gerado com os parâmetros preenchidos. Na aba CLI Example:
Clique em
para copiar o comando para a área de transferência.Clique em
para abrir o Cloud Shell e executar o comando no navegador.
O OpenAPI Explorer adiciona --region aos comandos gerados por padrão. Quando presente, essa opção substitui as configurações do perfil padrão e das variáveis de ambiente. Mantenha ou remova o parâmetro conforme seu fluxo de trabalho. Para requisitos de formatação de parâmetros, consulte Parameter formats .
Chamar operações da API do ApsaraDB RDS
Sintaxe do comando
Todos os comandos da Alibaba Cloud CLI seguem esta estrutura. Consulte Command structure para mais detalhes.
aliyun <command> <subcommand> [options and parameters]Opções comuns de comando
|
Opção |
Descrição |
|
|
Usa o perfil de configuração especificado. Substitui a configuração de credenciais padrão e as variáveis de ambiente. |
|
|
Executa o comando na região indicada. Substitui a configuração de credenciais padrão e as variáveis de ambiente. |
|
|
Exibe informações de ajuda para um comando. Consulte Usar o comando help. |
Para ver todas as opções disponíveis, acesse Opções de linha de comando.
Exemplo 2: Consultar detalhes da instância
O comando abaixo chama DescribeDBInstanceAttribute para recuperar a configuração completa de uma instância RDS:
aliyun rds DescribeDBInstanceAttribute --region cn-hangzhou --DBInstanceId 'pgm-bp16k272p478****'|
Parâmetro |
Descrição |
Exemplo |
|
|
Região onde a instância está localizada |
|
|
|
ID da instância RDS a ser consultada |
|
Saída:
{
"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"
}Solução de problemas
Se uma chamada de API retornar um erro, verifique se os nomes e valores dos parâmetros correspondem à referência da API para essa operação.
Para diagnósticos de autoatendimento, acesse a Plataforma de Diagnóstico da OpenAPI da Alibaba Cloud e insira o RequestId obtido na resposta de erro.
Próximos passos
What is Alibaba Cloud CLI? — visão geral completa dos recursos
Parameter formats — como passar tipos de parâmetros complexos (arrays JSON, structs)
Opções de linha de comando — todos os flags suportados e suas regras de precedência