Alibaba Cloud CLI は、Alibaba Cloud サービスとその API 情報と統合されています。Alibaba Cloud CLI で --help オプションを追加して、ヘルプ情報を取得できます。
利用可能なサービスとグローバルオプションのクエリ
--help オプションを aliyun コマンドに追加して、共通のコマンドオプションとサポートされているサービスをクエリできます。
次のコマンドを実行します。
aliyun --helpサンプルレスポンス(一部):
shell@Alicloud:~$ aliyun --help Alibaba Cloud CLI 3.0.276 Usage: aliyun <product> <operation> [--parameter1 value1 --parameter2 value2 ...] Flags: --mode `--mode {AK|StsToken|RamRoleArn|EcsRamRole|RsaKeyPair|RamRoleArnWithRoleName}` を使用して認証方式を指定します。 --profile,-p `--profile <profileName>` を使用してプロファイルを指定します。 ... --help ヘルプ情報を表示します。 Sample: aliyun ecs DescribeRegions Products: actiontrail ActionTrail adb AnalyticDB for MySQL adcp 分散クラウドコンテナプラットフォーム Kubernetes 版 ...
サービスの利用可能な API 操作のクエリ
サービスコードの後に --help オプションを追加して、サービスで利用可能な API 操作のリストをクエリします。リモートプロシージャコール (RPC) スタイルの API 操作の説明が表示されます。リソース指向アーキテクチャ (ROA) スタイルの API 操作のエンドポイントが表示されます。
Alibaba Cloud CLI は、操作の説明の前に次のインジケーターを使用して、操作のステータスまたは特性を示します。
[Anonymous]: 認証なしで呼び出すことができる匿名操作を示します。このタイプの操作を呼び出すには。詳細については、「汎用的な呼び出し」をご参照ください。[Deprecated]: 操作が非推奨であることを示します。この操作の新しいバージョンに切り替えることを推奨します。
RPC
次のコマンドを実行して、Elastic Compute Service (ECS) で使用可能な API オペレーションを照会します。
aliyun ecs --help予想されるレスポンス:
shell@Alicloud:~$ aliyun ecs --help Alibaba Cloud CLI 3.0.276 Usage: aliyun ecs <ApiName> --parameter1 value1 --parameter2 value2 ... Product: Ecs (ECS) Version: 2014-05-26 Available Api List: AcceptInquiredSystemEvent システムイベントに対する操作を受け入れて承認します。照会状態のシステムイベントの場合、この操作はシステムイベントのデフォルト操作を受け入れて、システムがデフォルト操作を実行することを承認します。 ActivateRouterInterface [非推奨] 非アクティブなルーターインターフェースをアクティブにします。 AddBandwidthPackageIps [非推奨] AddTags ECS リソースに 1 つ以上のタグを追加または上書きします。インスタンス、ディスク、スナップショット、イメージ、セキュリティグループなどの ECS リソースにタグを追加して、簡単に管理できます。 ...
ROA
次のコマンドを実行して、Container Service for Kubernetes (ACK) で使用可能な API オペレーションを照会します。
aliyun cs --help予想されるレスポンス:
shell@Alicloud:~$ aliyun cs --help Alibaba Cloud CLI 3.0.276 Usage 1: aliyun cs [GET|PUT|POST|DELETE] <PathPattern> --body "..." Usage 2 (For API with NO PARAMS in PathPattern only.): aliyun cs <ApiName> --parameter1 value1 --parameter2 value2 ... --body "..." Product: CS (ACK) Version: 2015-12-15 Available Api List: AttachInstances : POST /clusters/[ClusterId]/attach AttachInstancesToNodePool : POST /clusters/[ClusterId]/nodepools/[NodepoolId]/attach CancelClusterUpgrade : POST /api/v2/clusters/[ClusterId]/upgrade/cancel CancelComponentUpgrade : POST /clusters/[clusterId]/components/[componentId]/cancel ...
API パラメータの詳細を照会する
API 操作の後に --help オプションを追加して、パラメーター名やパラメータータイプなどのパラメーター詳細をクエリできます。ROA スタイルの API 操作のリクエストメソッドとエンドポイントも表示されます。
RPC
次のコマンドを実行して、Elastic Compute Service の
DescribeRegions操作に関するパラメーター詳細をクエリします。aliyun ecs DescribeRegions --help予想されるレスポンス:
shell@Alicloud:~$ aliyun ecs DescribeRegions --help Alibaba Cloud CLI 3.0.276 Product: Ecs (ECS) Parameters: --AcceptLanguage String オプション レスポンスのフィルタリングに使用する自然言語。詳細については、https://tools.ietf.org/html/rfc7231 の RFC7231 をご参照ください。有効な値: - zh-CN: 中国語 - en-US: 英語 - ja: 日本語 デフォルト値: zh-CN。 --InstanceChargeType String オプション インスタンスの課金方法。詳細については、「課金概要」をご参照ください。有効な値: - PrePaid: サブスクリプション。このパラメータを PrePaid に設定する場合は、アカウントに十分な残高またはクレジットがあることを確認してください。そうでない場合、InvalidPayMethod エラーコードが返されます。 - PostPaid: 従量課金。 デフォルト値: PostPaid。 --ResourceType String オプション リソースのタイプ。有効な値: - instance: ECS インスタンス - disk: ディスク - reservedinstance: リザーブドインスタンス - scu: SCU (Storage Capacity Unit) デフォルト値: instance
ROA
次のコマンドを実行して、Container Service for Kubernetes の
AttachInstances操作に関するパラメーター詳細をクエリします。aliyun cs AttachInstances --help予想されるレスポンス:
shell@Alicloud:~$ aliyun cs AttachInstances --help Alibaba Cloud CLI 3.0.276 Product: CS (ACK) Method: POST PathPattern: /clusters/[ClusterId]/attach Parameters: --ClusterId String 必須 クラスタの ID。 --body Struct オプション リクエストボディパラメータ。