すべてのプロダクト
Search

このプロダクト

    Elastic Compute Service:ListPluginStatus

    ドキュメントセンター

    Elastic Compute Service:ListPluginStatus

    最終更新日:Apr 04, 2026

    Elastic Compute Service (ECS) インスタンス上のクラウドアシスタントプラグインの状態をクエリします。

    操作説明

    • この操作を呼び出して ECS インスタンス上のクラウドアシスタントプラグインのステータスをクエリする前に、インスタンス上のクラウドアシスタントエージェントのバージョンが次のバージョン以降であることを確認してください。

      • Linux インスタンス：2.2.3.344

      • Windows インスタンス：2.1.3.344

    • ページングクエリ中に `ListPluginStatus` 操作を呼び出して結果の最初のページを取得する場合、`MaxResults` を設定して呼び出しで返されるエントリの最大数を指定します。`NextToken` の戻り値は、次回の呼び出しで結果の新しいページを取得するために使用できるページネーショントークンです。`ListPluginStatus` 操作を呼び出して結果の新しいページを取得する場合、`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。

    string

    任意

    N 番目のインスタンスの ID。各リクエストで最大 50 個のインスタンス ID を指定できます。N の有効値：1～50。

    i-bp1iudwa5b1tqa****
    RegionId

    string

    必須

    インスタンスのリージョン ID。`DescribeRegions` 操作を呼び出して、最新のリージョンリストをクエリできます。

    cn-hangzhou
    Name

    string

    任意

    クラウドアシスタントプラグインの名前。名前はすべての文字セットをサポートし、長さは 1～255 文字である必要があります。

    • このパラメーターが指定されていない場合、指定されたインスタンスにインストールされているすべてのクラウドアシスタントプラグインのステータスがクエリされます。

      注 このパラメーターが指定されていない場合、指定できるインスタンス ID は 1 つのみです。

    • このパラメーターが指定されている場合、指定されたクラウドアシスタントプラグインのステータスがクエリされます。

    testPluginName
    PageNumber

    integer

    任意

    説明

    このパラメーターは将来削除される予定です。ページングクエリには `NextToken` と `MaxResults` を使用することを推奨します。

    1
    PageSize

    integer

    任意

    説明

    このパラメーターは将来削除される予定です。ページングクエリには `NextToken` と `MaxResults` を使用することを推奨します。

    10
    MaxResults

    integer

    任意

    ページあたりの最大エントリ数。

    有効値：1～50。

    デフォルト値：10。

    10
    NextToken

    string

    任意

    次のリクエストで結果の新しいページを取得するために使用されるページネーショントークン。`NextToken` の値として、前回のクエリから取得したトークンを指定する必要があります。

    AAAAAdDWBF2

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    PageSize

    integer

    ページあたりのエントリ数。

    10
    RequestId

    string

    リクエスト ID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
    PageNumber

    integer

    ページ番号。

    1
    TotalCount

    integer

    返されたエントリの総数。

    1
    NextToken

    string

    `NextToken` の戻り値はページネーショントークンであり、次のリクエストで結果の新しいページを取得するために使用できます。

    AAAAAdDWBF2
    InstancePluginStatusSet

    object

    InstancePluginStatus

    array<object>

    インスタンス上のクラウドアシスタントプラグインの状態。

    array<object>

    InstanceId

    string

    インスタンスの ID。

    i-xxxxx
    PluginStatusSet

    object

    PluginStatus

    array<object>

    クエリされたクラウドアシスタントプラグイン。

    object

    PluginStatus

    string

    クラウドアシスタントプラグインの状態。有効値：

    • NotInstalled：プラグインはインストールされていません。

    • Installed：1回限りのプラグインがインストールされています。

    • Running：長時間実行プラグインが実行中です。

    • Stopped：長時間実行プラグインは実行されていません。

    • Crashed：プラグインは異常です。

    • Removed：プラグインはアンインストールされています。

    • Unknown：プラグインの状態は不明です。

    Running
    PluginVersion

    string

    プラグインのバージョン。

    1.1
    PluginName

    string

    プラグインの名前。

    testName
    FirstHeartbeatTime

    string

    クラウドアシスタントがプラグインの状態を最初に報告した時刻。

    2020-01-19T09:15:46Z
    LastHeartbeatTime

    string

    クラウドアシスタントがプラグインの状態を最後に報告した時刻。

    2020-01-19T09:15:46Z

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 RegionId.ApiNotSupported The api is not supported in this region.
    400 InvalidParam.PageNumber The specified parameter PageNumber is invalid.
    400 InvalidParam.PageSize The specified parameter PageSize is invalid.
    400 PluginName.MissingValue The plugin name must be specified when the number of InstanceIds is not 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.
    500 InternalError.Dispatch An error occurred when you dispatched the request.
    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.

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

    変更履歴

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