Querying Alarm Rules Associated with an Alarm Template
Function
This API is used to query alarm rules associated with the alarm template.
URI
GET /v2/{project_id}/alarm-templates/{template_id}/association-alarms
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. |
| template_id | Yes | String | ID of an alarm template. The ID starts with at and is followed by up to 64 characters, including letters and digits. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| offset | No | Integer | Start position for pagination query, indicating the sequence number of the data record where the query starts. The default value is 0. |
| limit | No | Integer | Maximum number of query results. The value ranges from 1 to 100 (default). |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Tenant token. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| alarms | Array of alarms objects | Alarm rule list. |
| count | Integer | Total number of alarm rules. |
| Parameter | Type | Description |
|---|---|---|
| alarm_id | String | Alarm rule ID. |
| name | String | Alarm rule name. |
| description | String | Description of the alarm rule. |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Status codes customized by each cloud service when a request error occurs. |
| error_msg | String | Request error message. |
| request_id | String | Request ID. |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Status codes customized by each cloud service when a request error occurs. |
| error_msg | String | Request error message. |
| request_id | String | Request ID. |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Status codes customized by each cloud service when a request error occurs. |
| error_msg | String | Request error message. |
| request_id | String | Request ID. |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Status codes customized by each cloud service when a request error occurs. |
| error_msg | String | Request error message. |
| request_id | String | Request ID. |
Example Requests
Query alarm rules associated with an alarm template.
/v2/{project_id}/alarm-templates/{template_id}/association-alarms Example Responses
Status code: 200
OK
{
"alarms" : [ {
"alarm_id" : "al12345678901234567890",
"name" : "test",
"description" : "Alarm rule list."
} ],
"count" : 100
} Status Codes
| Status Code | Description |
|---|---|
| 200 | OK |
| 400 | Parameter verification failed. |
| 401 | Not authenticated. |
| 403 | Authentication failed. |
| 500 | Internal system error. |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot