Cloud Shell は OpenAPI Explorer にあらかじめインストールされています。 Cloud Shell は Alibaba Cloud CLI に構築されたオンラインの CLI ツールです。 AccessKey のインスト―ル、設定は不要です。
Alibaba Cloud プロダクトの API は、RPC API と RESTful API の 2 種類に分けられます。 ほとんどのプロダクトは RPC を使用しています。 種類の異なる API は、呼び出す方法も異なります。
以下の特性によって API の種類を判断できます:
パラメータには
Action
フィールドを含める API は RPC で、PathPattern
フィールドを含める API は RESTful です。通常、プロダクト内のすべての API の種類は同じです。
各 API でサポートする呼び出し方法が 1 つのみで、間違った方法で呼び出しすると
ApiNotFound
エラーが返されます。
Cloud Shell の使用
以下の手順に従って、OpenAPI Explorer で Cloud Shell を使用します。
ウェブブラウザを起動し、「https://api.aliyun.com」を入力して OpenAPI Explorer にアクセスします。
トップメニューで、[Online Linux Shell] をクリックします。
Alibaba Cloud アカウントで Cloud Shell にログインします。
アリクラウドCloud Shellに直接アクセスすることもできます。
Cloud Shell での RPC API の呼び出し
次のコマンドを使用して RPC API を呼び出します:
aliyun <ProductCode> <ActionName> [--parameter1 value1 --parameter2 value2]
説明:
ProductCode :呼び出すプロダクトのコード。 例えば、ECS の製品コードは
ecs
で、SLB の製品コードはslb
です。aliyun --help
コマンドを実行して、プロダクトコードを取得します。ActionName :呼び出す API。 たとえば、
DescribeInstanceAttribute
API を呼び出して、ECS インスタンスの詳細情報を表示します。parameter :API のパラメータ。 各パラメータの詳細は、各プロダクトの API 資料をご参照ください。
例
次のコマンドを実行して ECS インスタンスの詳細情報を表示します。
コマンドを実行する前に、表示したい ECS インスタンスの ID を変更します。
aliyun ecs DescribeInstanceAttribute --InstanceId i-bp198exxxxxx | jq
Cloud Shell での RESTful API の呼び出し
Container Service などの一部の Alibaba Cloud プロダクトは RESTful API を提供します。 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//attach --header "Content-Type=application/json" --body "$(cat attach.json)"
DELETE リクエスト
aliyun <ProductCode> DELETE /<Resource>
例
aliyun cs DELETE /clusters/<cluster-id>