この操作では、CloudMonitor エージェントがインストールされているホストの一覧を取得します。
デバッグ
API Explorer を使用してデバッグを実行できます。 API Explorer を使用することで、さまざまな操作を実行して API の使用を簡素化できます。 たとえば、API の取得、API の呼び出し、SDK サンプルコードの動的生成を行うことができます。
リクエストパラメーター
パラメーター | データ型 | 必須/省略可能 | 例 | 説明 |
Action | String | 省略可能 | DescribeMonitoringAgentHosts | 実行する操作。 値を DescribeMonitoringAgentHosts に設定します。 |
HostName | String | 省略可能 | hostNam1 | ホストの名前。 |
InstanceIds | String | 省略可能 | i-a3d1q1pm2f9yr29e**** | インスタンスの ID 。 |
InstanceRegionId | String | 省略可能 | cn-hangzhou | インスタンスの regionId 。 |
KeyWord | String | 省略可能 | host1 | あいまい一致するキーワード。 |
PageNumber | Integer | 省略可能 | 1 | ページ数。 |
PageSize | Integer | 省略可能 | 10 | 各ページのレコード数。 |
SerialNumbers | String | 省略可能 | a1ab31a3-1234-40f2-9e95-c8caa8f0**** | 探すホストのシリアル番号。 |
レスポンスパラメーター
パラメーター | データ型 | 例 | 説明 |
Code | String | 200 | ステータスコード。 値が 200 の場合、呼び出しが成功したことを示します。 |
Hosts | ホストの一覧。 | ||
└AgentVersion | String | 2.1.55 | CloudMonitor エージェントのバージョン。 |
└AliUid | Long | 123456 | Alibaba Cloud アカウントの AccessKey ID 。 |
└EipAddress | String | 22.22.XX.XX | ホストの EIP。 |
└EipId | String | xxx | EIP の ID。 |
└HostName | String | hostIP | ホストの名前。 |
└InstanceId | String | i-a2d5q7pm3f9yr212**** | インスタンスの ID 。 |
└InstanceTypeFamily | String | ecs.n4 | ECS インスタンスの種類。 |
└IpGroup | String | 12.23.XX.XX | ホストの IP アドレス 複数の状態をコンマ (,) で区切る必要があります。 |
└NatIp | String | 22.22.XX.XX | NAT IP アドレス。 |
└NetworkType | String | vpc | ネットワークの種類。 |
└OperatingSystem | String | Linux | オペレーティングシステム。 |
└Region | String | cn-hangzhou | リージョンの名前。 |
└SerialNumber | String | x12335-6cc8-4a22-9f21-1a00a719**** | シリアル番号。 |
└isAliyunHost | Boolean | true | 現在のホストが Alibaba Cloud であるかを示します。 |
Message | String | Successfully | エラーメッセージ。 |
PageTotal | Integer | 50 | ページの番号。 |
RequestId | String | 63EEBB2A-9E51-41E4-9E83-5DE7F3B292E0 | リクエストの ID 。 |
Success | Boolean | true | 呼び出しが成功したかを示します。 値が true の場合、呼び出しが成功したことを示します。 値が false の場合、呼び出しが失敗したことを示します。 |
Total | Integer | 10 | 返されるレコードの総数。 |
例
リクエスト例
http(s)://[Endpoint]/? Action=DescribeMonitoringAgentHosts
&<Common request parameters>
通常のレスポンス例
XML
形式
<DescribeMonitoringAgentHostsResponse>
<PageTotal>1</PageTotal>
<PageNumber>1</PageNumber>
<PageSize>100</PageSize>
<Hosts>
<Host>
<AgentVersion>2.1.55</AgentVersion>
<SerialNumber>x12335-6cc8-4a22-9f21-1a00a719****</SerialNumber>
<NetworkType>vpc</NetworkType>
<Region>cn-hangzhou</Region>
<InstanceTypeFamily>ecs.n4</InstanceTypeFamily>
<isAliyunHost>true</isAliyunHost>
<IpGroup>12.23.XX.XX</IpGroup>
<AliUid>127067667954****4</AliUid>
<InstanceId>i-a2d5q7pm3f9yr29e****</InstanceId>
<OperatingSystem>Linux</OperatingSystem>
<HostName>sitemonitor-mengmai-1</HostName>
</Host>
</Hosts>
<Success>true</Success>
<Code>200</Code>
<Total>2</Total>
</DescribeMonitoringAgentHostsResponse>
JSON
形式
{
"PageTotal":1,
"PageNumber":1,
"PageSize":100,
"Hosts":{
"Host":[
{
"SerialNumber":"x12335-6cc8-4a22-9f21-1a00a719****",
"AgentVersion":"2.1.55",
"NetworkType":"vpc",
"Region":"ap-south-1",
"IpGroup":"12.23.XX.XX",
"isAliyunHost":true,
"InstanceTypeFamily":"ecs.n4",
"AliUid":"127067667954****",
"InstanceId":"i-a2d5q7pm3f9yr212****",
"OperatingSystem":"Linux",
"HostName":"sitemonitor-mengmai-1"
}
]
},
"Success":true,
"Code":200,
"Total":20
}