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

Tableaux JSON

• Linux / macOS : utilisez des guillemets simples pour la couche externe et des guillemets doubles pour les valeurs internes.

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

• Windows (Invite de commandes et PowerShell) : utilisez des guillemets doubles pour la couche externe et des guillemets simples pour les valeurs internes.

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

Objets JSON

Lorsqu'une valeur de paramètre est un objet JSON, entourez chaque objet JSON d'accolades {} et séparez les clés et les valeurs par des deux-points :.

• Linux / macOS :

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

• Windows (Invite de commandes et PowerShell) :

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

Valeurs commençant par un trait d'union (-)

Lorsqu'une valeur de paramètre commence par -, la CLI peut l'interpréter à tort comme un autre nom de paramètre :

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

Utilisez un signe égal pour connecter le nom du paramètre et sa valeur afin de résoudre ce problème :

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

Caractères spéciaux du shell

Lorsque les valeurs des paramètres contiennent des caractères spéciaux du shell ($, , \, espaces, etc.), vous devez les entourer de guillemets. Sous Linux / macOS, utilisez des guillemets simples pour empêcher le shell d'interpréter les caractères spéciaux. Sous l'invite de commandes Windows, utilisez des guillemets doubles.

# 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 (appels d'API RESTful)

Dans les appels d'API RESTful, utilisez --body-file pour charger le corps de la requête HTTP depuis un fichier local.

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

Substitution de commande shell et here-doc

Vous pouvez également utiliser la substitution de commande shell ($(cat ...)) ou un here-doc pour transmettre le contenu du fichier au paramètre --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
)"