Alibaba Cloud CLI:Alibaba Cloud CLI コマンドパラメーターの理解

グローバルフラグ

次のフラグは、リージョンの指定、クエリ結果のページネーション、ドライランモードの有効化など、すべてのプラグインコマンドに適用されます：

ビジネスパラメーター

ビジネスパラメーターは、サブコマンドに渡されるリクエストフィールドです。オペレーションによってビジネスパラメーターは異なります。

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

ビジネスパラメーターのデータ型は API によって定義されます。一般的な型は次のとおりです：

• String：インスタンス ID や名前などのテキスト文字列です。

• Integer：ページ番号や件数などの整数です。

• Boolean：true または false のブール値です。

• Array / JSON：ディスク ID のリストやタグオブジェクトなどの配列または JSON オブジェクトです。

CLI ヘルプ情報の使用

コマンドに --help を付けて実行すると、サポートされているすべてのパラメーターとその説明を表示できます。ヘルプ出力の形式は、コマンドの種類によって異なります。

組み込みコマンド

組み込みコマンドは Alibaba Cloud CLI のコアプログラムに統合されており、configure など、追加のプラグインをインストールせずにそのまま使用できます。組み込みコマンドのヘルプ出力には、サブコマンドまたは特定のオプションが表示されます：

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

aliyun ecs DescribeInstances --help

Product: Ecs (Elastic Compute Service)

Parameters:
  --RegionId String  Required

  The region ID of the instance. You can call the [DescribeRegions](~~25609~~) operation to query the most recent region list.

  --AdditionalAttributes.n RepeatList Optional

  The additional instance attributes.
......

OpenAPI ポータルの使用

Alibaba Cloud OpenAPI ポータルでは、API をオンラインでデバッグでき、CLI コマンドの例も自動生成されます。詳細については、「OpenAPI Explorer を使用した CLI コマンドの生成と実行」をご参照ください。

一般的な型のパラメーター値

オペレーティングシステムやターミナル環境によって、引用符の扱いは異なります。特殊文字を含むパラメーター値を渡す場合は、次の引用符ルールを使用してください：

JSON 形式のパラメーター値

一部のコマンドパラメーターでは、値を JSON 形式で指定する必要があります。外側の引用符と内側の引用符の選択はオペレーティングシステムによって異なります。

特殊文字を含む値

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

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

# 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'

パラメーター値をファイルから読み込む

証明書や大きな JSON ペイロードなど、パラメーター値が長い場合は、ローカルファイルから値を読み込む方が便利です。

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

# コマンド置換
aliyun cs PUT /clusters/c1234****/nodepools/np5678**** --body "$(cat request.json)"

# ヒアドキュメント (スクリプト内でインライン JSON を構築する場合に適しています)
aliyun cs PUT /clusters/c1234****/nodepools/np5678**** --body "$(cat <<EOF
{
  "nodepool_info": {
    "name": "default-nodepool",
    "resource_group_id": "rg-acfmyvw****"
  }
}
EOF
)"

--help でパラメーターが Optional と表示されます。常に省略できますか？

必ずしもそうではありません。一部のコマンドでは相互排他的なパラメーターがあり、どちらか一方を指定する必要があります。このようなパラメーターは個別には Optional と表示されますが、少なくとも 1 つは指定しなければなりません。指定しない場合はエラーが返されます。具体的な要件ルールについては、該当プロダクトの API ドキュメントをご参照ください。