ListInstanceStatus API によるインスタンスステータスのクエリ - SAS

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

swas-open:ListInstanceStatus

get

*Instance

acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	シンプルアプリケーションサーバーが配置されているリージョン ID。ListRegions 操作を呼び出して、最新のリージョンリストを照会できます。	cn-hangzhou
InstanceIds	string	任意	シンプルアプリケーションサーバーの ID。値は、最大 100 個のシンプルアプリケーションサーバー ID で構成される JSON 配列です。複数のサーバー ID はコンマ (,) で区切ります。	["2ad1ae67295445f598017499dc**", "2ad1ae67295445f598017123dc**"]
PageNumber	integer	任意	ページ番号。	1
PageSize	integer	任意	ページあたりのエントリ数。	10

レスポンスフィールド

フィールド	型	説明	例
	object
InstanceStatuses	array<object>	シンプルアプリケーションサーバーの ID。
	object	インスタンスのステータス情報。
Status	string	シンプルアプリケーションサーバーのステータス。有効な値： Pending Starting Running Stopping Stopped Resetting Upgrading Disabled	Running
InstanceId	string	シンプルアプリケーションサーバーの ID。	a9a6474b935d41bcb531250bb5d****
RequestId	string	リクエスト ID。	30637AD6-D977-4833-A54C-CC89483E****
PageSize	integer	ページあたりのエントリ数。	10
PageNumber	integer	ページ番号。	1
TotalCount	integer	返されたエントリの総数。	54

例

成功レスポンス

JSONJSON

{
  "InstanceStatuses": [
    {
      "Status": "Running",
      "InstanceId": "a9a6474b935d41bcb531250bb5d****"
    }
  ],
  "RequestId": "30637AD6-D977-4833-A54C-CC89483E****",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 54
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
500	InternalError	An error occurred while processing your request.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。