DescribeMonitoringAgentHosts 操作を呼び出すと、CloudMonitor エージェントのインストール状況に関わらず、すべてのホストのリストを照会できます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cms:DescribeMonitoringAgentHosts |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| KeyWord |
string |
任意 |
あいまい検索用のキーワード。 |
host1 |
| HostName |
string |
任意 |
ホスト名。 |
hostNam1 |
| InstanceIds |
string |
任意 |
インスタンス ID。 |
i-a3d1q1pm2f9yr29e**** |
| SerialNumbers |
string |
任意 |
ホストのシリアル番号。 CloudMonitor エージェントがホストに正常にインストールされると、グローバルに一意のシリアル番号が生成されます。 Alibaba Cloud インスタンスではないホストにはインスタンス ID はありませんが、シリアル番号はあります。 説明
このパラメーターを使用して、特定の監視対象ホストを検索します。 |
a1ab31a3-1234-40f2-9e95-c8caa8f0**** |
| PageNumber |
integer |
任意 |
ページ番号。 |
1 |
| PageSize |
integer |
任意 |
各ページに返すエントリ数。 有効な値：
説明
Alibaba Cloud はこのパラメーターの最大値を制限しません。 ただし、このパラメーターに大きな値を設定すると、タイムアウトが発生する可能性があります。 |
10 |
| InstanceRegionId |
string |
任意 |
インスタンスが所在するリージョン。 |
cn-hangzhou |
| AliyunHost |
boolean |
任意 |
Alibaba Cloud Elastic Compute Service (ECS) インスタンスでフィルターするかどうかを指定します。 有効な値：
|
true |
| Status |
string |
任意 |
ホストのステータス。 有効な値：
|
Running |
| SysomStatus |
string |
任意 |
SysOM のステータス。 有効な値：
|
running |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答。 |
||
| RequestId |
string |
リクエスト ID。 |
63EEBB2A-9E51-41E4-9E83-5DE7F3B292E0 |
| Success |
boolean |
操作が成功したかどうかを示します。 有効な値：
|
true |
| Code |
string |
ステータスコード。 説明
ステータスコード 200 は、リクエストが成功したことを示します。 |
200 |
| Message |
string |
エラーメッセージ。 |
The Request is not authorization. |
| PageNumber |
integer |
ページ番号。 |
1 |
| PageSize |
integer |
1 ページあたりのエントリ数。 |
10 |
| PageTotal |
integer |
ページ数。 |
50 |
| Total |
integer |
エントリの総数。 |
10 |
| Hosts |
object |
||
| Host |
array<object> |
ホストのリスト。 |
|
|
object |
ホスト。 |
||
| SerialNumber |
string |
ホストのシリアル番号。 Alibaba Cloud インスタンスではないホストにはインスタンス ID はありませんが、シリアル番号はあります。 説明
このパラメーターを使用して、特定の監視対象ホストを検索します。 |
x12335-6cc8-4a22-9f21-1a00a719**** |
| NatIp |
string |
NAT IP アドレス。 |
192.168.XX.XX |
| HostName |
string |
ホスト名。 |
hostIP |
| AliUid |
integer |
Alibaba Cloud アカウントの ID。 |
103201326074**** |
| NetworkType |
string |
ネットワークタイプ。 |
vpc |
| InstanceId |
string |
インスタンス ID。 |
i-a2d5q7pm3f9yr212**** |
| isAliyunHost |
boolean |
ホストが Alibaba Cloud インスタンスであるかどうかを示します。 有効な値：
|
true |
| EipAddress |
string |
Elastic IP アドレス (EIP)。 |
192.168.XX.XX |
| AgentVersion |
string |
エージェントのバージョン。 |
3.4.6 |
| IpGroup |
string |
ホストの IP アドレス。 説明
複数の IP アドレスはコンマ (,) で区切られます。 |
192.168.XX.XX |
| EipId |
string |
EIP の ID。 |
eip-bp16i16k9gcezyfrp**** |
| Region |
string |
リージョン。 |
cn-hangzhou |
| InstanceTypeFamily |
string |
ECS インスタンスファミリー。 |
ecs.n4 |
| OperatingSystem |
string |
オペレーティングシステム。 |
Linux |
例
成功レスポンス
JSONJSON
{
"RequestId": "63EEBB2A-9E51-41E4-9E83-5DE7F3B292E0",
"Success": true,
"Code": "200",
"Message": "The Request is not authorization.",
"PageNumber": 1,
"PageSize": 10,
"PageTotal": 50,
"Total": 10,
"Hosts": {
"Host": [
{
"SerialNumber": "x12335-6cc8-4a22-9f21-1a00a719****",
"NatIp": "192.168.XX.XX",
"HostName": "hostIP",
"AliUid": 0,
"NetworkType": "vpc",
"InstanceId": "i-a2d5q7pm3f9yr212****",
"isAliyunHost": true,
"EipAddress": "192.168.XX.XX",
"AgentVersion": "3.4.6",
"IpGroup": "192.168.XX.XX",
"EipId": "eip-bp16i16k9gcezyfrp****",
"Region": "cn-hangzhou",
"InstanceTypeFamily": "ecs.n4",
"OperatingSystem": "Linux"
}
]
}
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | ParameterInvalid | Illegal parameters. | |
| 500 | InternalError | The request processing has failed due to some unknown error. | |
| 403 | AccessForbidden | User not authorized to operate on the specified resource. | |
| 404 | ResourceNotFound | The specified resource is not found. | The specified resource is not found. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。