A Alibaba Cloud CLI é uma ferramenta de linha de comando de uso geral desenvolvida com base no OpenAPI Explorer. Use-a para automatizar o gerenciamento e a manutenção de recursos do ENS, incluindo chamadas de operações da API do ENS.
Antes de começar
Familiarize-se com a Alibaba Cloud CLI. Para mais informações, consulte O que é a Alibaba Cloud CLI?
Instale a Alibaba Cloud CLI
A Alibaba Cloud CLI está disponível para Windows, Linux e macOS. Selecione o pacote de instalação correspondente ao seu sistema operacional:
Você também pode usar o Cloud Shell para depurar comandos da Alibaba Cloud CLI. Para mais informações, consulte O que é o Cloud Shell?
Configure a Alibaba Cloud CLI
Uma conta Alibaba Cloud tem permissões para gerenciar e acessar as APIs de todos os serviços da Alibaba Cloud. O uso dessa conta para chamar operações de API pode gerar riscos de segurança. Recomendamos criar e usar um usuário do Resource Access Management (RAM) para chamar APIs ou executar tarefas rotineiras de operação e manutenção.
Antes de usar a Alibaba Cloud CLI, configure suas credenciais de identidade e o ID da região. A ferramenta oferece suporte a diversos tipos de credenciais. Para mais detalhes, consulte Tipos de credenciais. Este exemplo usa credenciais AccessKey.
-
Crie um usuário RAM e conceda-lhe as permissões necessárias. Para mais informações, consulte Criar um usuário RAM e Conceder permissões a um usuário RAM.
ImportanteNeste exemplo, conceda a política
AliyunENSFullAccessao usuário RAM. Essa política garante controle total para consultar e modificar instâncias do ENS. Se preferir, conceda a políticaAliyunENSReadOnlyAccessou crie uma política personalizada conforme necessário. Para mais informações, consulte Referência de políticas personalizadas do ENS. Após criar e autorizar o usuário RAM, gere um par de AccessKey para ele. Registre o
AccessKey IDe oAccessKey Secretpara configurar as credenciais. Para mais informações, consulte Criar um par de AccessKey.-
Obtenha e registre o ID de uma região disponível. A Alibaba Cloud CLI usa esse ID para iniciar chamadas de API. Para verificar as regiões disponíveis, consulte Endpoints.
NotaAo usar a Alibaba Cloud CLI, use a opção
--regionpara definir uma região específica para um único comando. Essa opção substitui a configuração de região padrão nas credenciais e nas variáveis de ambiente. Para mais informações, consulte Opções de comando. Use o par de AccessKey do usuário RAM para configurar credenciais baseadas em AccessKey. Nomeie o perfil de configuração como AkProfile. Para mais informações, consulte Configurar e gerenciar credenciais de identidade.
Gere um comando CLI
Faça login na página de depuração de API do ENS.
-
Na página de depuração, use a caixa de pesquisa à esquerda para localizar a API desejada. Na seção Parameter Configuration, preencha os parâmetros obrigatórios. Em seguida, clique em CLI Example, ao lado da seção Parameter Configuration, para gerar um exemplo de comando.
Clique em
. Você será redirecionado para o Cloud Shell, onde poderá depurar o comando.-
Clique em
para copiar o comando CLI para a área de transferência e cole-o no shell local.Ao colar o comando de exemplo no shell para depuração, observe os formatos dos parâmetros. Para mais detalhes sobre os formatos de parâmetros da Alibaba Cloud CLI, consulte Formatos de parâmetros.
O exemplo gerado pelo OpenAPI Explorer inclui a opção
--regionpor padrão. Ao executar o comando localmente, a Alibaba Cloud CLI prioriza essa opção e ignora as configurações de região definidas nas credenciais padrão e nas variáveis de ambiente. Mantenha ou remova essa opção conforme necessário.
Chame uma operação de API
Sintaxe
A Alibaba Cloud CLI segue a sintaxe de comando abaixo. Para mais informações, consulte Sintaxe.
aliyun <command> <subcommand> [options and parameters]
Opções de comando
Especifique opções de comando para alterar o comportamento ou habilitar recursos estendidos. As opções mais comuns incluem:
--profile <profileName>: Ao usar a opção
--profilecom um nome de configuração válido profileName, a Alibaba Cloud CLI ignora as credenciais de identidade padrão e as variáveis de ambiente, priorizando a configuração especificada para invocar o comando.--help: Em qualquer nível de comando, use a opção--helppara obter ajuda específica. Para mais informações, consulte Obter informações de ajuda.
Para mais detalhes, consulte Opções de linha de comando para chamadas de API.
Exemplo de chamada
O exemplo a seguir chama o comando RebootInstance no ENS para reiniciar uma instância. Para mais informações sobre o comando RebootInstance, consulte RebootInstance.
-
Execute o seguinte comando:
aliyun ens RebootInstance --InstanceId i-5xxx8d3x --endpoint ens.aliyuncs.com -
Visualize a saída do comando.
{ "Code": "0", "RequestId": "845748BB-9E66-52DB-B4F5-4305601AD2CF" }
Se ocorrer um erro após chamar uma operação de API do ENS, verifique se os parâmetros e valores inseridos são válidos com base no código de erro retornado.
Você também pode registrar o ID da solicitação presente na resposta ou na mensagem de erro do SDK e usar o Alibaba Cloud OpenAPI Diagnostics para diagnosticar o problema.