Help & DocumentationCustom Cloud MonitorAPI DocumentsCustom Monitoring APIAlarm APIQuery Objects of Bound Alarm Rule
1. API Description
This API (DescribeAlarmRuleObjects) is used to query information of the objects that are bound with the alarm rule using the alarm rule ID.
Domain name: monitor.api.qcloud.com
2. Input Parameters
The following request parameter list only provides API request parameters. Common request parameters are also needed when the API is called. The Action field for this API is DescribeAlarmRuleObjects.
Parameter Name | Required | Type | Description |
---|---|---|---|
alarmRuleId | Yes | String | Rule ID, which can be queried by calling the API Query Alarm Rule (DescribeAlarmRuleList) |
offset | No | Int | Offset. Default is 0 (i.e. query result is displayed from the first alarm rule) |
limit | No | Int | Number of rows to be displayed in the result. Default is 30. Starting from offset, this number of alarm rules are displayed |
3. Output Parameters
Parameter Name | Type | Description |
---|---|---|
code | Int | Error code, 0: Successful. Other values: Failed. For more information, please see Common Error Codes on the Error Codes page |
message | String | Error message |
data | Array | This field exists if there is additional returned information |
"data" is composed as follows:
Parameter Name | Type | Description |
---|---|---|
ruleBindList | Array | List of objects that are bound with the alarm rule (each element in the array is the detailed description of an object. For more information, please see example) |
total | Int | Number of objects bound with the alarm rule |
4. Example
Input
https://monitor.api.qcloud.com/v2/index.php? &<Common request parameters> &alarmRuleId=policy-ou3kyu2f
Output
{
"code": 0,
"message": "",
"data": {
"ruleBindList": [
{
"diskname": "sda",
"ip": "172.31.58.160"
}
],
"total": "1"
}
}