ListPluginStatus - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

インスタンス上のクラウドアシスタントプラグインのステータスを照会します。

操作説明

クラウドアシスタントプラグインのステータスを照会するには、インスタンス上のクラウドアシスタントエージェントのバージョンが以下のバージョン以上である必要があります。
- Linux: 2.2.3.344。
- Windows: 2.1.3.344。
ページングクエリで最初のページを照会する場合は、MaxResults のみを設定して返されるエントリ数を制限します。レスポンスで返される NextToken 値は、後続のページを照会するためのトークンとして使用されます。後続のページを照会する場合は、NextToken パラメーターを前のレスポンスで取得した NextToken 値に設定し、MaxResults を設定して返されるエントリ数を制限します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:ListPluginStatus

get

*Instance。

acs:ecs:{#regionId}:{#accountId}:instance/{#InstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストを取得できます。	cn-hangzhou
InstanceId	array	任意	インスタンスの ID。1 回のリクエストで最大 50 個のインスタンスを指定できます。N の有効な値: 1～50。
	string	任意	インスタンスの ID。1 回のリクエストで最大 50 個のインスタンスを指定できます。N の有効な値: 1～50。	i-bp1iudwa5b1tqa****
Name	string	任意	プラグイン名。すべての文字セットがサポートされています。名前は最大 255 文字です。このパラメーターを指定しない場合、インスタンスにインストールされているすべてのプラグインのステータスが照会されます。説明このパラメーターを指定しない場合は、インスタンス ID を 1 つだけ指定できます。このパラメーターを指定した場合、インスタンス上の指定されたプラグインのステータスが照会されます。	testPluginName
PageNumber	integer	任意	説明このパラメーターは非推奨となる予定です。ページングを実行するには、NextToken および MaxResults を使用します。	1
PageSize	integer	任意	説明このパラメーターは非推奨となる予定です。ページングを実行するには、NextToken および MaxResults を使用します。	10
MaxResults	integer	任意	ページングクエリの 1 ページあたりの最大エントリ数。最大値: 50。デフォルト値: 10。	10
NextToken	string	任意	ページネーショントークン。このパラメーターを、前の API 呼び出しで返された NextToken 値に設定します。	AAAAAdDWBF2

レスポンスフィールド

フィールド	型	説明	例
	object
InstancePluginStatusSet	object
InstancePluginStatus	array<object>	インスタンスプラグインステータスのリスト。
	array<object>	インスタンスプラグインステータスのリスト。
InstanceId	string	インスタンス ID	i-xxxxx
PluginStatusSet	object
PluginStatus	array<object>	プラグインステータスのリスト。
	object	プラグインステータスのリスト。
FirstHeartbeatTime	string	クラウドアシスタントが最初にプラグインステータスを報告した時間。時間は ISO 8601 形式で、協定世界時 (UTC) で表示されます。	2020-01-19T09:15:46Z
LastHeartbeatTime	string	クラウドアシスタントが最後にプラグインステータスを報告した時間。時間は ISO 8601 形式で、協定世界時 (UTC) で表示されます。	2020-01-19T09:15:46Z
PluginName	string	プラグイン名。	testName
PluginStatus	string	プラグインのステータス。有効な値: NotInstalled: プラグインがインストールされていません。 Installed: ワンタイムプラグインがインストールされています。 Running: 常駐プラグインが実行中です。 Stopped: 常駐プラグインが実行されていません。 Crashed: プラグインのステータスが異常です。 Removed: プラグインがアンインストールされています。 UnKnown: ステータスが不明です。	Running
PluginVersion	string	プラグインのバージョン番号。	1.1
NextToken	string	この呼び出しで返されるページネーショントークン。	AAAAAdDWBF2
PageNumber	integer	クエリ結果のページ番号。	1
PageSize	integer	ページあたりのエントリ数。	10
RequestId	string	リクエスト ID	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
TotalCount	integer	クエリ条件に一致するレコードの総数。	1

例

成功レスポンス

JSONJSON

{
  "InstancePluginStatusSet": {
    "InstancePluginStatus": [
      {
        "InstanceId": "i-xxxxx",
        "PluginStatusSet": {
          "PluginStatus": [
            {
              "FirstHeartbeatTime": "2020-01-19T09:15:46Z",
              "LastHeartbeatTime": "2020-01-19T09:15:46Z",
              "PluginName": "testName",
              "PluginStatus": "Running",
              "PluginVersion": "1.1"
            }
          ]
        }
      }
    ]
  },
  "NextToken": "AAAAAdDWBF2",
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "TotalCount": 1
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	RegionId.ApiNotSupported	The api is not supported in this region.	指定されたリージョンでは API 呼び出しがサポートされていません。RegionId パラメーター値が正しいかどうかを確認してください。
400	InvalidParam.PageNumber	The specified parameter PageNumber is invalid.	指定された PageNumber パラメーターが無効です。
400	InvalidParam.PageSize	The specified parameter PageSize is invalid.	指定された PageSize パラメーターが無効です。
400	PluginName.MissingValue	The plugin name must be specified when the number of InstanceIds is not 1.	指定されたインスタンス数が 1 でない場合、プラグイン名を指定する必要があります。
400	InstanceIds.ExceedLimit	The number of instance IDs exceeds the upper limit.
400	InvalidParameter.NextToken	The specified parameter NextToken is not valid.
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.	指定された MaxResults パラメーターは無効です。
500	InternalError.Dispatch	An error occurred when you dispatched the request.	リクエストの送信中にエラーが発生しました。後でもう一度お試しください。
403	InvalidParameterCharacter	The specified parameter %s contains illegal characters.
403	Operation.Forbidden	The operation is not permitted.	操作は許可されていません。
404	InvalidInstance.NotFound	The specified instance does not exist.	指定されたインスタンスが存在しません。
404	InvalidPluginName.NotFound	The specified plugin name does not exist.	指定されたプラグイン名が存在しません。

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

変更履歴

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