Primeiros passos com o Yunxiao CLI - Alibaba Cloud DevOps: Central de Documentação do Alibaba Cloud

O Alibaba Cloud CLI é uma ferramenta de linha de comando baseada na OpenAPI para gerenciar serviços do Apsara DevOps, como Codeup (gerenciamento de código), Flow (pipelines) e Packages (gerenciamento de artefatos). Este guia de início rápido mostra como instale o Alibaba Cloud CLI, configure credenciais do Apsara DevOps e chamar operações da OpenAPI do Yunxiao. O exemplo usa o comando flow-get-flow-tag-group para obter detalhes de grupos de tags de pipeline.

Pré-requisitos

Uma conta Alibaba Cloud
Uma organização Apsara DevOps (Yunxiao), edição Region
Um token de acesso pessoal do Yunxiao, criado no console do Yunxiao. Para obter instruções, consulte Obter um token de acesso pessoal.
(Opcional) Caso não tenha familiaridade com o Alibaba Cloud CLI, consulte O que é o Alibaba Cloud CLI.

Etapa 1: Instale o Alibaba Cloud CLI

Instale o Alibaba Cloud CLI conforme seu sistema operacional:

Você também pode usar o Cloud Shell para execute comandos do Alibaba Cloud CLI sem instalação local. Para mais informações, consulte O que é o Cloud Shell.

Etapa 2: Configure o Yunxiao CLI

Importante

O sistema de identidade do Apsara DevOps difere de outros serviços da Alibaba Cloud. O Yunxiao não usa perfis (pares de AccessKey) para armazenar credenciais. Em vez disso, crie um token de acesso pessoal no console do Yunxiao e transmita-o por variáveis de ambiente ou parâmetros de linha de comando, não pelo aliyun configure.

Obter um token de acesso pessoal

Use um token de acesso pessoal para acessar operações da API do Yunxiao e execute operações Git via HTTP. Para mais informações, consulte Obter um token de acesso pessoal.

Aviso

Ao criar um token, selecione apenas as permissões de API mínimas necessárias e defina um período de validade adequado. Não crie tokens permanentes.
O token aparece somente no momento da criação. Não é possível visualize-o novamente. Armazene o token em um local seguro.
Não transmita tokens como texto simples na linha de comando. Use variáveis de ambiente.
Se houver vazamento de um token, exclua-o imediatamente.

Configure credenciais

O Yunxiao CLI aceita dois métodos de configuração de credenciais: variáveis de ambiente e parâmetros de linha de comando.

Método 1: Usar variáveis de ambiente (recomendado)

O Yunxiao CLI usa as seguintes variáveis de ambiente:

Variável de ambiente	Descrição	Obrigatória (Edição Region)
`ALIBABA_CLOUD_YUNXIAO_ACCESS_TOKEN`	Token de acesso pessoal do Yunxiao	Sim
`ALIBABA_CLOUD_YUNXIAO_API_BASE_URL`	Endpoint de API	Sim
`ALIBABA_CLOUD_YUNXIAO_ORGANIZATION_ID`	Identificador da organização	Não

Exemplo da Edição Region:

export ALIBABA_CLOUD_YUNXIAO_ACCESS_TOKEN=<your-personal-access-token>
export ALIBABA_CLOUD_YUNXIAO_API_BASE_URL=<your-api-base-url>

Método 2: Usar parâmetros de linha de comando

Você também pode transmitir credenciais como parâmetros em cada comando:

Parâmetro	Descrição	Obrigatório (Edição Region)
`--yunxiao-access-token`	Token de acesso pessoal do Yunxiao	Sim
`--api-base-url`	Endpoint de API	Sim
`--organization-id`	Identificador da organização	Não

Exemplo da Edição Region:

aliyun devops flow-get-flow-tag-group --id 0 \
  --api-base-url=<your-api-base-url> \
  --yunxiao-access-token=<your-personal-access-token>

Verifique sua configuração

Execute o comando a seguir para confirmar a disponibilidade do plugin do Yunxiao CLI:

aliyun devops version

Se o comando retornar informações de versão sem erros, o ambiente estará pronto.

Etapa 3: Chamar operações de API

Exemplo 1: Listar comandos disponíveis

Execute o seguinte comando para visualize todos os comandos do Yunxiao CLI:

aliyun devops --help

A saída retornada será semelhante a esta (parcial):

Description: Aliyun CLI plugin for yunxiao operations.

Usage: aliyun devops <command> [flags]

Available Commands:
  app-stack-create-application        Create an application
  app-stack-list-applications         List applications
  codeup-create-repository            Create a code repository
  codeup-list-repositories            List code repositories
  flow-create-pipeline                Create a pipeline
  flow-list-pipelines                 List pipelines
  flow-get-flow-tag-group             Get pipeline tag group details
  projex-search-projects              Search projects
  projex-search-workitems             Search work items
  ...

O Yunxiao CLI abrange os seguintes módulos:

Prefixo do módulo	Descrição
`app-stack-*`	AppStack (entrega de aplicações)
`base-*`	Base (organizações, membros e funções)
`codeup-*`	Codeup (gerenciamento de código)
`flow-*`	Flow (pipelines)
`insight-*`	Insight (análise de eficiência)
`packages-*`	Packages (gerenciamento de artefatos)
`projex-*`	Projex (colaboração em projetos)
`test-hub-*`	TestHub (gerenciamento de testes)

Nota

No site internacional (alibabacloud.com), apenas os módulos Codeup, Flow e Packages estão disponíveis. Comandos com os prefixos projex-*, test-hub-*, app-stack-* e insight-* não são suportados no site internacional.

Exemplo 2: Obter detalhes do grupo de tags de pipeline

O exemplo a seguir chama o comando flow-get-flow-tag-group para obter detalhes do grupo de tags de pipeline.

# Region edition (environment variables)
export ALIBABA_CLOUD_YUNXIAO_ACCESS_TOKEN=<your-personal-access-token>
export ALIBABA_CLOUD_YUNXIAO_API_BASE_URL=<your-api-base-url>

aliyun devops flow-get-flow-tag-group --id 0

Resposta de exemplo:

{
  "id": 0,
  "name": "Environment Tags",
  "tags": [
    {
      "id": 1,
      "name": "Production",
      "color": "#FF6B6B"
    },
    {
      "id": 2,
      "name": "Staging",
      "color": "#4ECDC4"
    }
  ]
}

Nota

Se ocorrer um erro ao chamar uma operação da OpenAPI do Yunxiao, verifique as causas comuns a seguir:

Token inválido ou expirado — Confirme se o seu token de acesso pessoal é válido e possui as permissões necessárias.
Endpoint incorreto — Certifique-se de usar o endpoint de API correto para a sua edição.
Parâmetros obrigatórios ausentes — A Edição Central exige o parâmetro --organization-id. A Edição Region requer o parâmetro --api-base-url.

Mais exemplos

Os exemplos a seguir demonstram operações comuns do Yunxiao CLI.

Listar repositórios de código

aliyun devops codeup-list-repositories --page 1 --per-page 20

Pesquisar projetos

aliyun devops projex-search-projects --page 1 --per-page 10

Listar pipelines

aliyun devops flow-list-pipelines --page 1 --per-page 20

Listar aplicações

aliyun devops app-stack-list-applications --pagination '{"page":1,"perPage":20}' --order-by createdAt

Filtrar saída usando JMESPath

aliyun devops codeup-list-repositories --cli-query 'result[].{name:name,id:id}'