Alibaba Cloud CLI:Understand Alibaba Cloud CLI command parameters

aliyun ecs describe-instances --biz-region-id cn-hangzhou --cli-dry-run

aliyun configure --help

configure credential and settings

Usage:
  aliyun configure --mode {AK|RamRoleArn|EcsRamRole|OIDC|External|CredentialsURI|ChainableRamRoleArn|CloudSSO|OAuth} --profile <profileName> [--config-path <configPath>]

Commands:
  get             print configuration values
  set             set config in non interactive mode
  list            list all config profile
  delete          delete the specified profile
  switch          switch default profile
  safety-policy   manage safety policy and human-in-the-loop rules
  ai-mode         manage global AI mode and User-Agent for API calls
  plugin-settings manage global plugin system settings

aliyun ecs describe-instances --help

Description: Queries a list of instances and their details based on specified conditions

API Version: 2014-05-26

Usage:
  aliyun ecs describe-instances [parameters]

Parameters:
  --biz-region-id                string (required), The ID of the region where the
                                 instance resides. You can call https://help.aliyun.
                                 com/document_detail/25609.html to query the latest
                                 list of Alibaba Cloud regions
  --additional-attributes        list, The list of other instance attributes
                                 format: --additional-attributes value1 value2 value3
  --device-available             bool, > This parameter is in invitational preview
                                 and is not available for use
......

Global Flags:
  --cli-ai-mode             bool, For this run, enable AI-mode
  --cli-dry-run             bool, Enable dry-run mode: print request details
                            without sending the actual API call
  --cli-query               string, Use `--cli-query <jmespath>` to filter
                            output with JMESPath expression
  --endpoint                string, Override service endpoint (e.g., --endpoint
                            https://ecs.cn-hangzhou.aliyuncs.com)
......

Examples:
  aliyun ecs describe-instances --biz-region-id example-value
  aliyun ecs describe-instances --biz-region-id example-value --vpc-id example-value

Arrays JSON

• Linux / macOS: Use aspas simples na camada externa e aspas duplas nos valores internos.

  aliyun ecs describe-disks --disk-ids '["d-bp1****","d-bp2****","d-bp3****"]' --biz-region-id cn-hangzhou

• Windows (Command Prompt e PowerShell): Use aspas duplas na camada externa e aspas simples nos valores internos.

  aliyun ecs describe-disks --disk-ids "['d-bp1****','d-bp2****','d-bp3****']" --biz-region-id cn-hangzhou

Objetos JSON

Quando o valor de um parâmetro for um objeto JSON, delimite cada objeto com chaves {} e separe chaves e valores com dois pontos :.

• Linux / macOS:

  aliyun slb add-backend-servers --load-balancer-id lb-bp1**** --backend-servers '[{"ServerId":"i-bp1****"},{"ServerId":"i-bp2****"}]'

• Windows (Command Prompt e PowerShell):

  aliyun slb add-backend-servers --load-balancer-id lb-bp1**** --backend-servers "[{'ServerId':'i-bp1****'},{'ServerId':'i-bp2****'}]"

Valores iniciados com hífen (-)

Se um valor de parâmetro começar com -, a CLI poderá interpretá-lo incorretamente como outro nome de parâmetro:

aliyun ecs AuthorizeSecurityGroup --SecurityGroupId 'sg-bp67acfmxazb4p****' --Permissions.1.PortRange "-1/-1" --method POST --force

Para resolver esse problema, use um sinal de igual para conectar o nome do parâmetro ao seu valor:

aliyun ecs AuthorizeSecurityGroup --SecurityGroupId 'sg-bp67acfmxazb4p****' --Permissions.1.PortRange=-1/-1 --method POST --force

Caracteres especiais do shell

Quando os valores de parâmetro contiverem caracteres especiais do shell ($, , \, espaços, entre outros), será obrigatório colocá-los entre aspas. No Linux / macOS, utilize aspas simples para impedir que o shell interprete os caracteres especiais. No Windows Command Prompt, use aspas duplas.

# Linux/macOS/PowerShell
aliyun ecs describe-images --image-name 'Example Image'
# Windows CMD
aliyun ecs describe-images --image-name "Example Image"

# Linux/macOS
aliyun xxx --param '$literal_dollar'

--body-file (chamadas de API RESTful)

Em chamadas de API RESTful, utilize --body-file para carregar o corpo da solicitação HTTP de um arquivo local.

aliyun cs PUT /clusters/c1234****/nodepools/np5678**** --body-file request.json

Substituição de comando do shell e here-doc

Também é possível usar substituição de comando do shell ($(cat ...)) ou here-doc para passar o conteúdo do arquivo ao parâmetro --body:

# Command substitution
aliyun cs PUT /clusters/c1234****/nodepools/np5678**** --body "$(cat request.json)"

# Here-doc (suitable for constructing inline JSON in scripts)
aliyun cs PUT /clusters/c1234****/nodepools/np5678**** --body "$(cat <<EOF
{
  "nodepool_info": {
    "name": "default-nodepool",
    "resource_group_id": "rg-acfmyvw****"
  }
}
EOF
)"