CloudMonitor エージェントのステータスをまとめて照会するには、この API を呼び出します。
デバッグ
OpenAPI Explorer でオンラインデバッグを実行できます。 OpenAPI Explorer は、オンライン API 呼び出し、動的 SDK サンプルコード生成、迅速な検索など、API の使用を簡単にするために役立つさまざまな機能を提供します。
リクエストパラメーター
パラメーター | データ型 | 必須/省略可能 | 値の例 | 説明 |
---|---|---|---|---|
InstanceIds | String | 必須 | i-abcdefgh123456,i-abcdefgh123457 |
インスタンスの ID。たとえば、i-22jja5c2l。 複数のインスタンス ID を区切るには、カンマ (,) を使用します。 |
Action | String | 省略可能 | NodeStatusList |
システムによって指定された API の名前 |
レスポンスパラメーター
パラメーター | データ型 | 値の例 | 説明 |
---|---|---|---|
ErrorCode | Integer | 200 |
返されたリクエストステータスコード。 ステータスコード 200 はリクエストが成功したことを示し、その他のステータスコードはリクエストが失敗したことを示します。 |
ErrorMessage | String | この操作には InstanceId が必須です。 |
リクエストが失敗したことを示すメッセージ |
NodeStatusList |
ノードステータスのリスト |
||
└AutoInstall | Boolean | true |
NodeInstall を使用して自動インストールを有効にするかどうかを示します。 |
└InstanceId | String | i-abcdefgh123456 |
インスタンスの ID |
└Status | String | running |
リファレンス NodeStatus Agent の実行ステータス |
RequestId | String | 1BB8FE8E-9BBE-490F-82EC-BF70FB849D55 |
リクエストのユニバーサル一意識別子(UUID)。エラーの特定に使用されます。 |
Success | Boolean | true |
操作が成功したかどうかを示します。 |
例
リクエストの例
http(s)://[Endpoint]/?Action=NodeStatusList
&InstanceIds=i-abcdefgh123456,i-abcdefgh123457
&<Common request parameters>
通常のレスポンスの例
XML
形式
<NodeStatusListResponse>
<NodeStatusList>
<NodeStatus>
<Status>running</Status>
<InstanceId> i-abcdefgh123456</InstanceId>
<AutoInstall>true</AutoInstall>
</NodeStatus>
<NodeStatus>
<Status>uninstalled</Status>
<InstanceId> i-abcdefgh123457</InstanceId>
<AutoInstall>true</AutoInstall>
</NodeStatus>
</NodeStatusList>
<Success>true</Success>
<ErrorCode>200</ErrorCode>
</NodeStatusListResponse>
JSON
形式
{
"NodeStatusList":{
"NodeStatus":[
{
"Status":"running",
"InstanceId":" i-abcdefgh123456",
"AutoInstall":true
},
{
"Status":"uninstalled",
"InstanceId":" i-abcdefgh123457",
"AutoInstall":true
}
]
},
"Success":true,
"ErrorCode":200
}
エラーコード
エラーコードの表示には、ここをクリックします。