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

:CLI を使用した API オペレーションの呼び出し

最終更新日:Jan 15, 2025

Cloud Shell は OpenAPI Explorer と統合されています。Cloud Shell は、Alibaba Cloud CLI によって提供される Web ベースの CLI です。インストールしたり AccessKey ペアを指定したりせずに Cloud Shell を使用できます。

Alibaba Cloud は RPC API と RESTful API を提供しています。ほとんどのクラウドサービスは、Elastic Compute Service(ECS)、ApsaraDB RDS、Server Load Balancer(SLB)などの RPC API を提供しています。

リクエストメソッドは、呼び出す API のアーキテクチャスタイルによって異なります。次の説明に基づいて API の種類を判断できます。

  • API が Action パラメーターを必要とする場合は RPC API です。API が PathPattern パラメーターを必要とする場合は RESTful API です。

  • 一般的に、クラウドサービス内のすべての API は同じ種類です。

Cloud Shell の起動

  1. OpenAPI Explorer にログオンします。

  2. 上部のナビゲーションバーで、[クラウドサービスの選択] をクリックします。表示されるパネルで、ターゲットのクラウドサービスを選択します。

  3. クラウドサービスの [ホームページ] の上部ナビゲーションバーで、[API デバッグ] をクリックします。表示されるページで、[CLI の例] タブをクリックします。

  4. [CLI の例] タブで、image.png アイコンをクリックして Cloud Shell を起動します。

    Alibaba Cloud Shell のページに直接アクセスすることもできます。

Cloud Shell で RPC API オペレーションを呼び出す

Cloud Shell で RPC API オペレーションを呼び出すときは、次のコマンド形式に従う必要があります。

aliyun <ProductCode> <ActionName> [--parameter1 value1 --parameter2 value2]

パラメーター

説明

ProductCode

クラウド製品コード。たとえば、Elastic Compute Service(ECS)の製品コードは ecs で、Server Load Balancer(SLB)のサービスコードは slb です。

aliyun --help コマンドを実行して、製品コードを表示できます。

Cloud Shell で次のコマンドを実行して、ECS インスタンスの構成を表示します。

説明

i-bp198exxxxxx を ECS インスタンスの ID に置き換えます。

aliyun ecs DescribeInstanceAttribute --InstanceId i-bp198exxxxxx | jq 

ActionName

呼び出す API オペレーション。たとえば、ECS の DescribeInstanceAttribute オペレーションを呼び出して、ECS インスタンスの詳細を表示できます。

parameter

リクエストパラメーター。詳細については、各 Alibaba Cloud サービスの API リファレンスを参照してください。

Cloud Shell で RESTful API オペレーションを呼び出す

RESTful API は、Container Service for Kubernetes(ACK)などの特定の Alibaba Cloud サービスに適用されます。RESTful API オペレーションは、RPC API オペレーションとは異なる方法で呼び出されます。次のセクションでは、Cloud Shell で RESTful API オペレーションを呼び出すために必要なコマンドの形式を示します。

  • GET リクエスト

    aliyun <ProductCode> GET /<Resource>

    aliyun cs GET /clusters
  • POST リクエスト

    aliyun <ProductCode> POST /<Resource> --body "$(cat input.json)"

    aliyun cs POST /clusters/<cluster-id> --header "Content-Type=application/json" --body "$(cat attach.json)"
  • DELETE リクエスト

    aliyun <ProductCode> DELETE /<Resource>

    aliyun cs DELETE /clusters/<cluster-id>