O Alibaba Cloud CLI permite automatizar o gerenciamento e a manutenção do Data Disaster Recovery pela linha de comando. Após concluir este tutorial, você poderá:
Instale e configure o Alibaba Cloud CLI com uma credencial de usuário RAM
Identificar as operações de API disponíveis no Data Disaster Recovery
Chamar uma operação de API e interpretar a resposta
Este tutorial usa DescribeBackupPlanBilling como exemplo prático.
Pré-requisitos
Antes de começar, verifique se você tem:
Uma conta Alibaba Cloud
Um usuário RAM com a política
AliyunDMSFullAccessanexada — veja Conceder permissões a um usuário RAMUm par de AccessKey para o usuário RAM — veja Criar um par de AccessKey
Uma conta Alibaba Cloud tem acesso total a todos os serviços da Alibaba Cloud. Crie um usuário do Resource Access Management (RAM) e conceda apenas as permissões necessárias, seguindo o princípio do menor privilégio. Para visualizar as políticas de permissão compatíveis com o Data Disaster Recovery, consulte Políticas de sistema predefinidas e Políticas personalizadas.
Etapa 1: Instale o Alibaba Cloud CLI
Escolha a opção adequada ao seu ambiente.
Opção A: Usar o Cloud Shell (nenhuma instalação necessária)
O Alibaba Cloud CLI já vem pré-instalado no Cloud Shell. O Cloud Shell também configura automaticamente uma credencial de identidade, o que permite pular a Etapa 2 e ir direto para a Etapa 3. Veja O que é o Cloud Shell?
Opção B: Instalar localmente
O Alibaba Cloud CLI é compatível com Windows, Linux e macOS. Siga o guia correspondente ao seu sistema operacional:
Para obter uma visão geral do Alibaba Cloud CLI, veja O que é o Alibaba Cloud CLI?
Etapa 2: Configure credenciais
Pule esta etapa se estiver usando o Cloud Shell — as credenciais são configuradas automaticamente.
Configure suas credenciais de AccessKey no Alibaba Cloud CLI usando uma configuração AkProfile:
Crie um usuário RAM e crie um par de AccessKey para esse usuário.
Anexe a política
AliyunDMSFullAccessao usuário RAM. Veja Conceder permissões a um usuário RAM.Localize o ID da região desejada. O Alibaba Cloud CLI envia solicitações de API para a região especificada. Veja Endpoints para consultar as regiões compatíveis com o Data Disaster Recovery.
Configure as credenciais de AccessKey no arquivo de configuração
AkProfile. Para um exemplo passo a passo, veja a seção "Exemplos de configuração" em Configurar credenciais.
O Alibaba Cloud CLI oferece suporte a vários tipos de credenciais. Para obter a lista completa, veja a seção "Tipos de credenciais" em Configurar credenciais.
Use a opção --region para direcionar qualquer comando a uma região específica. Isso substitui a região definida na configuração de credenciais e nas variáveis de ambiente. Veja Opções de linha de comando para chamadas de API.
Etapa 3: Gerar um comando de CLI
O OpenAPI Explorer gera comandos de CLI prontos para uso para cada operação de API do Data Disaster Recovery.
-
Abra a página DescribeBackupPlanBilling no OpenAPI Explorer.
Na aba Parameters, preencha os parâmetros da solicitação.
Clique na aba CLI Example para visualizar o comando gerado.
-
Copie ou execute o comando:
Clique em
para executar o comando diretamente no Cloud Shell.Clique em
para copiar o comando para a área de transferência e cole-o no seu shell local.
Por padrão, o OpenAPI Explorer adiciona --region aos comandos gerados. Ao executar o comando localmente, o Alibaba Cloud CLI usa essa região em vez daquela definida na configuração de credenciais. Remova ou mantenha a opção conforme sua necessidade. Para detalhes sobre o formato dos parâmetros, veja Formatos de parâmetros.
Etapa 4: Chamar operações de API
O Alibaba Cloud CLI integra as operações de API do Data Disaster Recovery da versão 2019-03-06 por padrão. Para chamar operações da versão 2021-01-01, use as opções --force e --version. O OpenAPI Explorer adiciona essas opções automaticamente ao gerar um comando para a API 2021-01-01.
Para fluxos de trabalho complexos que encadeiam múltiplos comandos, compile-os em um script de shell para melhorar a eficiência.
Para obter a lista completa de operações, consulte:
Listar operações de API disponíveis
Use a opção --help para visualizar todas as operações de API 2019-03-06 disponíveis no Alibaba Cloud CLI:
aliyun dbs --helpSaída esperada:
Consultar informações de faturamento do plano de backup
O exemplo a seguir chama DescribeBackupPlanBilling para consultar informações de faturamento de um plano de backup. Veja DescribeBackupPlanBilling para obter a referência completa de parâmetros.
aliyun dbs DescribeBackupPlanBilling --BackupPlanId 'dbstooi01ex****' --ShowStorageType trueSaída esperada:
{
"HttpStatusCode": 200,
"RequestId": "DD7BC7F5-4E3A-5DF3-BFF9-831503C4D9E3",
"Success": true,
"Item": {
"BuyCreateTimestamp": 1658372830000,
"FullStorageSize": 151,
"BuyExpiredTimestamp": 1661097600000,
"BuySpec": "micro",
"QuotaEndTimestamp": 1659283200000,
"IsExpired": true,
"QuotaStartTimestamp": 1656604800000,
"TotalFreeBytes": 858993459200,
"PaiedBytes": 0,
"UsedFullBytes": 0,
"IsFreeBytesUnlimited": true,
"ContStorageSize": 10437039,
"BuyChargeType": "PREPAY",
"UsedIncrementBytes": 9406734
}
}Solucionar erros
Se uma chamada de API retornar um erro, verifique o código de erro e valide se os parâmetros da solicitação e seus valores estão corretos.
Para diagnósticos de autoatendimento, acesse OpenAPI Troubleshoot e insira o ID da solicitação ou as informações de erro do SDK obtidas na resposta.
Próximos passos
Explore todas as operações disponíveis na referência de API (2019-03-06) e na referência de API (2021-01-01)
Use
--forcee--versionpara chamar operações2021-01-01— veja Forçar chamada de uma operação de API