All Documents
Current Document
Content is empty
If you don't find the content you expect, please try another search term
Content is empty
If you don't find the content you expect, please try another search term
Last updated：2026-03-18 14:12:49
Call the DescribePolicyObject API to retrieve the detailed list of instances associated with a specific alarm policy under the specified account.
Field | Value |
|---|---|
API Name | DescribePolicyObject |
Request Method | GET |
Endpoint |
|
VPC Internal Endpoint |
|
Version |
|
All requests must include the Common Request Parameters. The table below lists only the API-specific parameters.
Parameter | Required | Type | Description |
|---|---|---|---|
| Yes | String | Fixed value: |
| Yes | String | Fixed value: |
| Yes | Integer | The ID of the alarm policy to query. To retrieve policy IDs, see Query Alarm Policies. |
| No | Integer | Page number. Must be greater than or equal to |
| No | Integer | Number of records per page. Valid range: |
Both JSON and XML formats are supported.
Field | Type | Description |
|---|---|---|
| String | Unique request ID. |
| Integer | Total number of instances associated with this alarm policy. |
| Integer | Cloud service category ID of the alarm policy. See Cloud Service Categories. |
| Array of InstanceInfoObject | List of associated instance detail objects. See InstanceInfo Object below. |
Field | Type | Description |
|---|---|---|
| String | Unique ID of the associated instance. |
| String | IP address of the instance. |
| String | Display name of the instance. |
Replace
${region}with the appropriate region code. See: Region Reference. Replace${CommonParams}with the appropriate common parameters. See: Common Parameters.
curl -X GET 'https://monitor.${region}.api.ksyun.com/?Action=DescribePolicyObject&Version=2021-01-01&PolicyId=20000&PageIndex=1&PageSize=10' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'host: monitor.api.ksyun.com' \
-H 'cache-control: no-cache' \
-H ${CommonParams}
JSON Format
{
"data": {
"instanceInfoList": [
{
"instanceId": "8b759ff8-d71b-41b7-939f-xxxxxxxxxx",
"ip": "10.0.0.0",
"instanceName": "cms-test"
}
],
"productType": 15
},
"totalCount": 10,
"requestId": "xxxx"
}
XML Format
<Data>
<InstanceInfoList>
<InstanceId>8b759ff8-d71b-41b7-939f-xxxxxxxxxx</InstanceId>
<Ip>10.0.0.0</Ip>
<InstanceName>cms-test</InstanceName>
</InstanceInfoList>
<ProductType>15</ProductType>
</Data>
<TotalCount>10</TotalCount>
<RequestId>xxxxx</RequestId>
JSON Format
{
"requestId": "xxxx",
"error": {
"type": "sender",
"code": "InvalidParameterValue",
"message": "Invalid `PolicyId` parameter value, policy does not exist."
}
}
The table below lists only the error codes specific to this API's business logic. For all other error codes, refer to Common Error Codes.
Pure Mode