1. Interface Description
Interface request domain name: monitor.api3.convergecloud.com.
This API is used to query the list of alarm policies.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-07-22 18:09:06.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: DescribeAlarmPolicies |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-07-24 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| Module | Yes | No | String | The value is fixed to "monitor". Example: monitor |
| PageNumber | No | No | Int64 | Number of pages. It starts from 1 and the default value is 1. Example: 1 |
| PageSize | No | No | Int64 | Number of entries per page. Value range: 1-100. Default: 20. Example: 20 |
| PolicyName | No | No | String | Fuzzy search by policy name. Example: policy-24sxe890 |
| MonitorTypes | No | No | Array of String | Filters by monitor type. MT_QCE (Cloud Platform service monitoring). If this parameter is left empty, all will be queried by default. Example: ["MT_QCE"] |
| Namespaces | No | No | Array of String | Filters by namespace. Example: ["cvm_device"] |
| Measurements | No | No | Array of String | Filters by policy type (viewName) (for Cloud Platform service monitoring). Example: [cvm] |
| Dimensions | No | No | String | Alarm object list. Example: [[{"name":"unInstanceId","value":"ins-qr888845g"}]] |
| ReceiverUids | No | No | Array of Int64 | Searches by recipient Example: [9989] |
| ReceiverGroups | No | No | Array of Int64 | Searches by recipient group. Example: [1112] |
| PolicyType | No | No | Array of String | Filters by default policy. Valid values: DEFAULT (display default policy), NOT_DEFAULT (display non-default policies). If this parameter is left empty, all policies will be displayed. Example: ["DEFAULT"] |
| Field | No | No | String | Sort field. Example: PolicyId |
| Order | No | No | String | Sort order. Valid values: ASC (ascending), DESC (descending). Example: DESC |
| ProjectIds | No | No | Array of Int64 | Array of project IDs. Example: [1] |
| AlarmStatus | No | No | Array of Int64 | Obsolete field. Enable or disable. 1: enable. 0: disable. Example: [1] |
| NoticeIds | No | No | Array of String | Alarm notification ID list. Example: [1,2] |
| RuleTypes | No | No | Array of String | Filters by trigger condition. Valid values: STATIC (display policies with static threshold), DYNAMIC (display policies with dynamic threshold). If this parameter is left empty, all policies will be displayed. Example: [STATIC] |
| Enable | No | No | Array of Int64 | Enable or disable. 1: enable. 0: disable. Example: 1 |
| NotBindingNoticeRule | No | No | Int64 | Whether the notification rule is configured, 1: not configured; 0: configured. Example: 1 |
| InstanceGroupId | No | No | Int64 | Instance group ID. Example: 1 |
| ConditionTemplateId | No | No | Int64 | Condition template ID. Example: 1 |
| Like | No | No | String | Fuzzy match. Example: Abandoned |
| Limit | No | No | String | limit. Example: 10 |
| Offset | No | No | Int64 | Offset. Example: 0 |
| AlarmLevels | No | No | Array of String | Alarm Level Example: Remind |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| TotalCount | Int64 | Total number of policies. Example: 100 |
| Policies | Array of AlarmPolicy | Policy array. Example:View |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| UnsupportedOperation | Unsupported operation. |
| InternalError | Internal error. |
| FailedOperation | Operation failed. |