Use Alibaba Cloud CLI to call the OOS API - 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. Com o Alibaba Cloud CLI, você pode automatizar o gerenciamento e a manutenção no CloudOps Orchestration service. Este tópico descreve como usar o Alibaba Cloud CLI para chamar a api do CloudOps Orchestration service, com base em diversos exemplos práticos.

Antes de começar

Para mais informações sobre o Alibaba Cloud cli, consulte What is Alibaba Cloud CLI

Instale o Alibaba Cloud cli

É necessário instale o Alibaba Cloud cli antes de utilizá-lo. A ferramenta pode ser instalada nos sistemas operacionais Windows, Linux e macOS. Selecione o pacote de instalação adequado ao sistema operacional do seu dispositivo. Para mais informações, consulte os tópicos a seguir:

Sistema operacional Windows: Install Alibaba Cloud CLI on Windows
Sistema operacional Linux: Install, update, and uninstall Alibaba Cloud CLI
Sistema operacional macOS: Install Alibaba Cloud CLI on macOS

Você também pode usar o Cloud Shell fornecido pelo Alibaba Cloud para depurar os comandos que deseja executar no Alibaba Cloud cli. Para mais informações sobre o Cloud Shell, consulte What is Cloud Shell

configure o Alibaba Cloud cli

Importante

Uma conta do Alibaba Cloud tem permissões para gerencie e acesse as APIs de todos os serviços do Alibaba Cloud. Usar uma conta do Alibaba Cloud para chamar operações de api representa riscos de segurança. Recomendamos crie e utilize um usuário do Resource Access Management (ram) para chamar operações de api ou realizar operações rotineiras de O&M.

Antes de usar o Alibaba Cloud cli, configure informações como credenciais de identidade e um ID de região. O Alibaba Cloud cli oferece suporte a diversos tipos de credenciais de identidade. Para mais informações, consulte a seção "Identity credential types" do tópico configure identity credentials. Neste exemplo, são utilizadas credenciais do tipo AccessKey. Execute as etapas a seguir:

crie um usuário ram e conceda a ele as permissões necessárias para gerencie os serviços do Alibaba Cloud de acordo com os requisitos do seu negócio. Para mais informações, consulte create a ram user e Use ram for access control.
crie um par de AccessKey para o usuário ram e registre o AccessKey ID e o AccessKey secret para a configuração posterior das credenciais de identidade. Para mais informações, consulte create an AccessKey.
especifique um ID de região. O Alibaba Cloud cli chama as operações de api na região especificada. Para mais informações sobre as regiões disponíveis, consulte Endpoints.

Nota
Ao usar o Alibaba Cloud cli, você pode especifique a opção --region para execute um comando em uma região específica. Quando essa opção é especificada, o Alibaba Cloud cli ignora as informações de região nas configurações de credencial padrão e nas variáveis de ambiente. Para mais informações, consulte Command-line options.
Use o par de AccessKey do usuário ram para configure as credenciais de AccessKey no arquivo de configuração denominado AkProfile. Para mais informações, consulte a seção "Configuration examples" do tópico configure identity credentials.

Gerar um comando cli

acesse a página api debugging do OOS.
Na caixa de pesquisa à esquerda da página de depuração de api, pesquise a operação de api que deseja chamar. Na aba Parameters da operação de api, especifique os parâmetros conforme a referência da api. clique em cli Example à direita para visualize o comando de exemplo gerado com os parâmetros especificados.
- clique em o ícone para iniciar Cloud Shell e depurar o comando no Cloud Shell.
- clique em o ícone para copiar o comando de exemplo para a área de transferência. Em seguida, cole o comando no seu shell local para executá-lo.
  - Preste atenção aos formatos dos parâmetros ao colar o comando de exemplo no shell local para depuração. Para mais informações sobre os formatos de parâmetros em comandos do Alibaba Cloud cli, consulte Understand command parameters.
  - Por padrão, a opção --region é adicionada ao comando de exemplo gerado no openapi Explorer. Ao copiar o comando para o shell local, o Alibaba Cloud cli ignora as informações de região nas configurações de credencial padrão e nas variáveis de ambiente, executando o comando prioritariamente na região especificada. Você pode remover ou manter essa opção conforme os requisitos do seu negócio.

Chamar operações de api

Sintaxe

No Alibaba Cloud cli, utilize a seguinte sintaxe para execute comandos. Para mais informações, consulte a seção "Syntax" do tópico Generate and run cli commands.

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

Opções de comando comuns

No Alibaba Cloud cli, você pode especifique opções de comando para alterar o comportamento dos comandos ou habilitar recursos estendidos. As opções de comando mais comuns são:

--profile <profileName>: use a opção --profile com o parâmetro profileName para especifique um perfil de configuração. Após especifique um perfil de configuração válido, o Alibaba Cloud cli ignora as informações nas configurações de credencial padrão e nas variáveis de ambiente, utilizando prioritariamente as configurações especificadas para execute os comandos.
--help: use a opção --help para obter informações de ajuda sobre um comando. Para mais informações, consulte Use the help command.

Para mais informações, consulte Command-line options.

Código de exemplo

Exemplo 1: O código de exemplo a seguir descreve como usar a opção --help para obter a lista de operações de api do CloudOps Orchestration service com suporte no Alibaba Cloud cli. Você também pode visualize as operações de api disponíveis em api overview.

execute o seguinte comando:
```
aliyun oos --help
```
visualize o resultado.

Exemplo 2: O código de exemplo a seguir descreve como usar o Alibaba Cloud cli para chamar a operação CreateTemplate do OOS e crie um modelo chamado CLI_Template.

execute o seguinte comando:

Nota

O formato de entrada para parâmetros do tipo array JSON de strings varia conforme o sistema operacional. escolha e execute o comando correspondente ao seu sistema operacional. Para mais informações, consulte Understand command parameters.

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'}]}"

visualize o resultado.

{
  "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 uma operação de api do CloudOps Orchestration service retornar um erro, verifique se os parâmetros de entrada e seus valores são válidos com base no código de erro.

Você também pode usar Alibaba Cloud openapi Diagnostics para realizar diagnósticos de autoatendimento com base no ID da solicitação retornada ou nas informações de erro.