CLI reference - Certificate Management Service: Central de Documentação do Alibaba Cloud

Este tópico utiliza como exemplo a chamada da API Certificate Management Service (Original SSL Certificate) do ListDeploymentJob para recuperar uma lista de tarefas de implantação. O objetivo é demonstrar como usar a Alibaba Cloud CLI para invocar as OpenAPIs do Certificate Management Service.

Conceitos

A Alibaba Cloud Command Line Interface (CLI) é uma ferramenta de linha de comando de uso geral desenvolvida com base na OpenAPI. Essa ferramenta auxilia na automação do gerenciamento e da manutenção do Certificate Management Service. Para mais informações, consulte O que é a Alibaba Cloud CLI?.

Etapa 1: Instale a Alibaba Cloud CLI

Antes de utilizar a Alibaba Cloud CLI, é necessário instalá-la. A instalação pode ser feita em Windows, Linux e macOS. Escolha o método correspondente ao seu sistema operacional.

O Cloud Shell já vem com a Alibaba Cloud CLI pré-instalada e recebe atualizações regulares. Utilize o Cloud Shell para depurar comandos da Alibaba Cloud CLI. Para mais detalhes, veja O que é o Cloud Shell?.

Etapa 2: Configure a Alibaba Cloud CLI

Importante

As contas da Alibaba Cloud possuem permissões para gerenciar e acessar todas as operações de OpenAPI dos produtos, o que representa um alto risco de segurança. Recomendamos criar um usuário do Resource Access Management (RAM), conceder permissões a esse usuário seguindo o princípio do menor privilégio e utilizá-lo para acessar a OpenAPI. Para saber mais sobre as políticas de acesso compatíveis com o Certificate Management Service, consulte Políticas de sistema para o Certificate Management Service.

Para usar a CLI, configure suas credenciais de identidade e o ID da região. A ferramenta aceita diversos tipos de credenciais. Consulte Tipos de credencial para mais informações. Este exemplo demonstra como configurar credenciais AK utilizando o par de AccessKey de um usuário RAM. Siga o procedimento abaixo:

Crie um usuário RAM e um par de AccessKey para definir as credenciais de identidade. Veja Criar um usuário RAM e Criar um par de AccessKey para instruções detalhadas.
Conceda permissões ao usuário RAM. Neste cenário, atribua a permissão de somente leitura para o Certificate Management Service: AliyunYundunCertReadOnlyAccess. Acesse Gerencie permissões de usuário RAM para mais detalhes.
Obtenha um ID de região disponível para configurar as credenciais. A CLI utiliza a região especificada para realizar chamadas à OpenAPI. Verifique as regiões suportadas pelo Certificate Management Service em Endpoints.

Nota
Durante o uso da CLI, utilize a opção --region para definir uma região específica para um comando. Essa opção substitui as configurações de região padrão e as variáveis de ambiente. Consulte Opções de linha de comando para mais informações.
Configure as credenciais AK usando o par de AccessKey do usuário RAM. Nomeie o arquivo de configuração como AkProfile. Siga o exemplo em Exemplo de configuração.

Etapa 3: Gerar um exemplo de comando da CLI

No Portal da OpenAPI, acesse a página de depuração do ListDeploymentJob.
Na aba Parameter settings, insira os parâmetros da solicitação. Em seguida, clique em CLI Example para visualizar o exemplo gerado.
Copie o exemplo ou execute-o diretamente no Cloud Shell:
- Clique em Run Command para abrir o Cloud Shell e depurar o comando rapidamente.
- Clique em Copy para copiar o exemplo para a área de transferência. Depois, cole-o em uma ferramenta de shell local para executar o comando ou criar um script.
Nota
- Ao copiar o exemplo para uma ferramenta local, preste atenção ao formato dos parâmetros. Consulte Formato de parâmetro para entender a sintaxe correta dos comandos da Alibaba Cloud CLI.
- O exemplo gerado no Portal da OpenAPI inclui a opção --region por padrão. Ao executar o comando localmente, a CLI ignora a região definida nas credenciais padrão e nas variáveis de ambiente, utilizando apenas a região especificada na opção. Remova ou mantenha essa opção conforme sua necessidade.

Etapa 4: Chamar uma operação de OpenAPI do Certificate Management Service

Exemplo 1: Obter a lista de operações de OpenAPI do Certificate Management Service chamáveis via CLI

O exemplo a seguir demonstra como usar a opção --help para listar as operações de OpenAPI do Certificate Management Service disponíveis para chamada via CLI. Para mais detalhes, consulte Visão geral da API.

Nota

Utilize as opções --force e --version para chamar operações de OpenAPI referentes a certificados privados (Certificate Management Service/2020-06-30). Veja Forçar uma chamada de API para instruções.
Quando o Portal da OpenAPI gera um exemplo de comando para uma operação de certificado privado (Certificate Management Service/2020-06-30), ele adiciona automaticamente as opções --force e --version. Não é necessário incluí-las manualmente.
Para mais informações sobre a OpenAPI de certificados privados (Certificate Management Service/2020-06-30), acesse Visão geral da API.

Execute o comando abaixo.
```
aliyun cas --help
```
Saída esperada.

Exemplo 2: Obter uma lista de tarefas de implantação

Este exemplo ilustra como utilizar a CLI para chamar a operação ListDeploymentJob do Certificate Management Service e recuperar tarefas de implantação filtradas por tipo e status.

Execute o seguinte comando.

aliyun cas ListDeploymentJob --JobType user --Status pending

Saída esperada.

{
  "RequestId": "12345678-1234-1234-1234-123456789ABC",
  "Total": 7,
  "CurrentPage": 1,
  "ShowSize": 50,
  "Data": [
    {
      "Id": 19975,
      "GmtCreate": "1624343180000",
      "GmtModified": "1606482979000",
      "UserId": 0,
      "InstanceId": "cas-job-user-***",
      "Name": "job-test",
      "CertType": "upload",
      "ScheduleTime": "1606482979000",
      "StartTime": "1606482979000",
      "EndTime": "1606482979000",
      "Status": "scheduling",
      "Del": 1,
      "Rollback": 1,
      "JobType": "user",
      "CertDomain": "aliyundoc1.com,aliyundoc2.com,aliyundoc3.com",
      "ProductName": "NLB"
    }
  ]
}

Nota

Caso receba um erro ao chamar uma operação de OpenAPI do Certificate Management Service, verifique se os parâmetros da solicitação e seus valores estão corretos utilizando o código de erro retornado.
Anote o RequestID retornado ou a mensagem de erro do SDK e utilize a Plataforma de Diagnóstico da OpenAPI da Alibaba Cloud para realizar diagnósticos autosserviço.