すべてのプロダクト
Search
ドキュメントセンター

Alibaba Cloud CLI:help コマンドの使用

最終更新日:May 24, 2025

Alibaba Cloud CLI は、Alibaba Cloud サービスとその API 情報と統合されています。--help オプションを Alibaba Cloud CLI に追加して、ヘルプ情報を取得できます。

Alibaba Cloud CLI でサポートされている Alibaba Cloud サービスとコマンドのリストを照会する

--help オプションを aliyun コマンドに追加して、共通のコマンドオプションとサポートされているサービスを照会できます。

  1. 次のコマンドを実行します。

    aliyun --help
  2. サンプルレスポンス(一部):

    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 オペレーションのエンドポイントが表示されます。

RPC

  1. 次のコマンドを実行して、Elastic Compute Service (ECS) で使用可能な API オペレーションを照会します。

    aliyun ecs --help
  2. 予想されるレスポンス:

    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

  1. 次のコマンドを実行して、Container Service for Kubernetes (ACK) で使用可能な API オペレーションを照会します。

    aliyun cs --help
  2. 予想されるレスポンス:

    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

  1. 次のコマンドを実行して、Elastic Compute ServiceDescribeRegions API オペレーションに関するパラメータの詳細を照会します。

    aliyun ecs DescribeRegions --help
  2. 予想されるレスポンス:

    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

  1. 次のコマンドを実行して、Container Service for Kubernetesv API オペレーションに関するパラメータの詳細を照会します。

    aliyun cs AttachInstances --help
  2. 予想されるレスポンス:

    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  オプション
    
      リクエストボディパラメータ。