Todos os produtos
Search

Este produto

    Data Management:Exemplo de integração com CLI - DBS

    Central de documentação

    Data Management:Exemplo de integração com CLI - DBS

    Última atualização: Aug 28, 2026

    O Alibaba Cloud CLI permite automatizar o gerenciamento e a manutenção do Data Disaster Recovery via linha de comando. Após concluir este tutorial, você poderá:

    • Instale e configure o Alibaba Cloud CLI com uma credencial de usuário RAM

    • Descobrir 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:

    Importante

    Uma conta Alibaba Cloud tem acesso total a todos os services 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 as políticas de permissão compatíveis com o Data Disaster Recovery, consulte Predefined system policies e Custom policies.

    Etapa 1: Instale o Alibaba Cloud CLI

    Escolha a opção adequada ao seu ambiente.

    Opção A: Usar o Cloud Shell (sem instalação)

    O Alibaba Cloud CLI vem pré-instalado no Cloud Shell. O Cloud Shell também configura automaticamente uma credencial de identidade, permitindo pular a Etapa 2 e ir direto para a Etapa 3. Consulte What is Cloud Shell?

    Opção B: Instalação local

    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, consulte What is Alibaba Cloud CLI?

    Etapa 2: Configure credenciais

    Nota

    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:

    1. Create a RAM user e create an AccessKey pair para esse usuário.

    2. Anexe a política AliyunDMSFullAccess ao usuário RAM. Consulte Grant permissions to a RAM user.

    3. Localize o ID da região desejada. O Alibaba Cloud CLI envia solicitações de API para a região especificada. Consulte Endpoints para visualizar as regiões compatíveis com o Data Disaster Recovery.

    4. Configure as credenciais de AccessKey no arquivo de configuração AkProfile. Para um exemplo passo a passo, consulte a seção "Configuration examples" em Configure credentials.

    O Alibaba Cloud CLI oferece suporte a vários tipos de credenciais. Para obter a lista completa, consulte a seção "Credential types" em Configure credentials.

    Nota

    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. Consulte Command line options for API calls.

    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.

    1. Abra a página DescribeBackupPlanBilling no OpenAPI Explorer.

      image

    2. Na aba Parameters, preencha os parâmetros da solicitação.

    3. Clique na aba CLI Example para visualizar o comando gerado.

    4. Copie ou execute o comando:

      • Clique em image para executar o comando diretamente no Cloud Shell.

      • Clique em image para copiar o comando para a área de transferência e cole-o no shell local.

    Nota

    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 necessário. Para detalhes sobre o formato dos parâmetros, consulte Parameter formats.

    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 aumentar 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 --help

    Saída esperada:

    image

    Consultar informações de faturamento da programação de backup

    O exemplo a seguir chama DescribeBackupPlanBilling para consultar informações de faturamento de uma programação de backup. Consulte DescribeBackupPlanBilling para a referência completa de parâmetros.

    aliyun dbs DescribeBackupPlanBilling --BackupPlanId 'dbstooi01ex****' --ShowStorageType true

    Saí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 os parâmetros da solicitação e seus valores.

    Para diagnóstico 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