1. Interface Description
Interface request domain name: monitor.api3.convergecloud.com.
API for creating alarm policies
Default interface request rate limit: 20 times per second.
Interface update time: 2025-07-22 18:11:39.
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: CreateAlarmPolicy |
| 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 |
| PolicyName | Yes | No | String | Policy name, which can contain up to 20 characters. Example: CVM alarm policy |
| Remark | No | No | String | Remarks, which can contain up to100 letters, digits, underscores, and hyphens. Example: Policy demo |
| MonitorType | Yes | No | String | Monitor type. Valid values: MT_QCE (Cloud Platform service monitoring) Example: MT_QCE |
| Enable | No | No | Int64 | Whether to enable. Valid values: 0 (no), 1 (yes). Default value: 1. This parameter can be left empty. Example: 1 |
| ProjectId | No | No | Int64 | Project ID. Valid values: -1 (no project), 0 (default project). Default value: -1. This parameter can be left empty. Example: 0 |
| Namespace | Yes | No | String | Alarm policy type such as cvm_device, which is obtained through the DescribeAllNamespaces API. Example: cvm_device |
| PolicyExpression | No | No | String | Bare write alarm rules including trigger rules and filter conditions. Example: 29936048 AND 2993604 |
| ConditionTemplateId | No | No | Int64 | ID of the trigger condition template. This parameter can be left empty. Example: 123456 |
| Condition | No | No | AlarmPolicyCondition | Metric trigger condition. Example:View |
| EventCondition | No | No | Array of AlarmPolicyEventCondition | Event trigger condition. Example:View |
| NoticeIds | No | No | Array of String | List of notification rule IDs, which is obtained through the DescribeAlarmNotices API. Example: ["notice-bv9b4ghqbg","notice-gj2n9wnt29"] |
| TriggerTasks | No | No | Array of AlarmPolicyTriggerTask | List of trigger tasks. Example:View |
| AlarmLevel | No | No | String | Alarm Level Example: Remind |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| PolicyId | String | Alarm policy ID. Example: policy-abc123 |
| OriginId | String | Policy ID for APIs for binding and unbinding instances or instance groups (BindingPolicyObject, UnBindingAllPolicyObject, UnBindingPolicyObject). Example: 1234556 |
| 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 |
|---|---|
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| ResourceNotFound | The resource does not exist. |
| FailedOperation | Operation failed. |
| UnsupportedOperation | Unsupported operation. |
| LimitExceeded | The quota limit has been reached. |
| InvalidParameterValue | Invalid parameter value. |