Use Alibaba Cloud CLI para chamar a API do OOS - CloudOps Orchestration Service: Central de Documentação do Alibaba Cloud

O Alibaba Cloud CLI é uma ferramenta de linha de comando de uso geral desenvolvida com base no OpenAPI Explorer. Use o Alibaba Cloud CLI para automatizar tarefas de gerenciamento e manutenção no CloudOps Orchestration Service. Este tópico descreve como usar o Alibaba Cloud CLI para chamar a API do CloudOps Orchestration Service por meio de exemplos.

Antes de começar

Para obter mais informações sobre o Alibaba Cloud CLI, consulte O que é o Alibaba Cloud CLI

Instale o Alibaba Cloud CLI

Instale o Alibaba Cloud CLI antes de usá-lo. A instalação é compatível com os sistemas operacionais Windows, Linux e macOS. Escolha o pacote de instalação adequado ao sistema operacional do seu dispositivo. Para mais detalhes, consulte os tópicos a seguir:

Windows: Instalar o Alibaba Cloud CLI no Windows
Linux: Instalar, atualizar e desinstalar o Alibaba Cloud CLI
macOS: Instalar o Alibaba Cloud CLI no macOS

Você também pode usar o Cloud Shell da Alibaba Cloud para depurar comandos do Alibaba Cloud CLI. Para saber mais sobre o Cloud Shell, consulte O que é o Cloud Shell

Configure o Alibaba Cloud CLI

Importante

Uma conta Alibaba Cloud tem permissões para gerenciar e acessar as APIs de todos os serviços da Alibaba Cloud. O uso direto dessa conta para chamar operações de API gera riscos de segurança. Recomendamos criar e usar um usuário do Resource Access Management (RAM) para invocar operações de API ou executar tarefas rotineiras de O&M.

Antes de usar o Alibaba Cloud CLI, configure informações como credenciais de identidade e ID da região. A ferramenta oferece suporte a diversos tipos de credenciais. Para mais detalhes, consulte a seção "Tipos de credenciais de identidade" no tópico Configurar credenciais de identidade. Neste exemplo, usamos credenciais AccessKey. Siga as etapas abaixo:

Crie um usuário RAM e conceda a ele as permissões necessárias para gerenciar os serviços da Alibaba Cloud conforme suas necessidades de negócio. Para mais informações, consulte Criar um usuário RAM e Usar o RAM para controle de acesso.
Gere um par de AccessKey para o usuário RAM e anote o AccessKey ID e o AccessKey secret para configurar as credenciais posteriormente. Consulte Criar um AccessKey para mais detalhes.
Especifique um ID de região. O Alibaba Cloud CLI executa as chamadas de API na região definida. Para verificar as regiões disponíveis, acesse Endpoints.

Nota
Durante o uso do Alibaba Cloud CLI, adicione a opção --region para executar comandos em uma região específica. Ao definir essa opção, a ferramenta ignora a região configurada nas credenciais padrão e nas variáveis de ambiente. Veja mais em Opções de linha de comando.
Use o par de AccessKey do usuário RAM para configurar as credenciais no arquivo AkProfile. Consulte a seção "Exemplos de configuração" no tópico Configurar credenciais de identidade para obter instruções detalhadas.

Gerar um comando CLI

Acesse a página de API debugging do OOS.
Na caixa de pesquisa à esquerda da página de depuração de API, localize a operação de API desejada. Na aba Parameters, preencha os parâmetros conforme a referência da API. Em seguida, clique em na aba CLI Example à direita para visualizar o comando de exemplo gerado com os parâmetros especificados.
- Clique em no ícone para iniciar o Cloud Shell e depurar o comando diretamente na nuvem.
- Clique em no ícone para copiar o comando de exemplo para a área de transferência. Depois, cole-o no shell local para execução.
  - Verifique a formatação dos parâmetros ao colar o comando no shell local para depuração. Para entender melhor os formatos de parâmetros no Alibaba Cloud CLI, consulte Entender os parâmetros de comando.
  - Por padrão, o OpenAPI Explorer inclui a opção --region no comando gerado. Ao copiá-lo para o ambiente local, o Alibaba Cloud CLI prioriza essa região em detrimento das configurações padrão de credenciais ou variáveis de ambiente. Mantenha ou remova essa opção conforme sua necessidade.

Chamar operações de API

Sintaxe

No Alibaba Cloud CLI, use a sintaxe abaixo para executar comandos. Consulte a seção "Sintaxe" do tópico Gerar e executar comandos CLI para mais informações.

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

Opções comuns de comando

Ao usar o Alibaba Cloud CLI, especifique opções de comando para alterar comportamentos ou habilitar funcionalidades estendidas. As opções mais frequentes incluem:

--profile <profileName>: Use a opção --profile seguida do parâmetro profileName para definir um perfil de configuração específico. Um perfil válido faz com que o Alibaba Cloud CLI ignore as credenciais padrão e variáveis de ambiente, priorizando as configurações indicadas para a execução dos comandos.
--help: Adicione a opção --help para exibir informações de ajuda sobre um comando. Saiba mais em Usar o comando help.

Para obter uma lista completa, consulte Opções de linha de comando.

Código de exemplo

Exemplo 1: O código abaixo demonstra como usar a opção --help para listar as operações de API do CloudOps Orchestration Service com suporte no Alibaba Cloud CLI. Também é possível verificar as operações disponíveis na Visão geral da API.

Execute o seguinte comando:
```
aliyun oos --help
```
Visualize o resultado.

Exemplo 2: Este exemplo ilustra como usar o Alibaba Cloud CLI para invocar a operação CreateTemplate do OOS e criar um modelo chamado CLI_Template.

Execute o comando correspondente:

Nota

O formato de entrada para parâmetros de lista de arrays JSON do tipo string varia conforme o sistema operacional. Selecione e execute o comando apropriado para o seu ambiente. Consulte Entender os parâmetros de comando para mais detalhes.

Linux/macOS

aliyun oos CreateTemplate --RegionId 'cn-hangzhou' --TemplateName CLI_Template --Content '{"FormatVersion": "OOS-2019-06-01", "Description": "Describe instances of given status", "Parameters": {"Status": {"Type": "String", "Description": "(Required) The status of the Ecs instance."}}, "Tasks": [{"Properties": {"Parameters": {"Status": "{{ Status }}"}, "API": "DescribeInstances", "Service": "Ecs"}, "Name": "foo", "Action": "ACS::ExecuteApi"}]}'

Windows

aliyun oos CreateTemplate --RegionId 'cn-hangzhou' --TemplateName CLI_Template --Content "{'FormatVersion': 'OOS-2019-06-01', 'Description': 'Describe instances of given status', 'Parameters': {'Status': {'Type': 'String', 'Description': '(Required) The status of the Ecs instance.'}}, 'Tasks': [{'Properties': {'Parameters': {'Status': '{{ Status }}'}, 'API': 'DescribeInstances', 'Service': 'Ecs'}, 'Name': 'foo', 'Action': 'ACS::ExecuteApi'}]}"

Confira o resultado retornado.

{
  "RequestId": "989F0944-E653-5826-9FA7-8ADE6E66F485",
  "Template": {
    "Description": "Describe instances of given status",
    "CreatedBy": "test(2039927162697*****)",
    "TemplateFormat": "JSON",
    "ResourceGroupId": "rg-acfmykd6*****",
    "UpdatedDate": "2024-08-05T10:28:24Z",
    "TemplateVersion": "v1",
    "Hash": "8abc5921b5a05051992*****",
    "UpdatedBy": "test(2039927162697*****)",
    "HasTrigger": false,
    "CreatedDate": "2024-08-05T10:28:24Z",
    "TemplateName": "CLI_Template",
    "Tags": {},
    "TemplateId": "t-9246d5246f*****",
    "ShareType": "Private"
  }
}

Nota

Se ocorrer um erro ao chamar uma operação de API do CloudOps Orchestration Service, valide os parâmetros e valores enviados com base no código de erro apresentado.

Você também pode usar a Alibaba Cloud OpenAPI Diagnostics para realizar diagnósticos autônomos usando o ID da solicitação ou as mensagens de erro retornadas.