monitor · 2018-07-24

CreateAlarmPolicy

POST

Create an alarm policy.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /monitor/CreateAlarmPolicy path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.

curl

curl -sS https://monitor.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/monitor/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: monitor.api3.convergecloud.com' \
  -H 'X-TC-Action: CreateAlarmPolicy' \
  -H 'X-TC-Version: 2018-07-24' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{}'

Request parameters

Field	Type	Required	Description
Module	string	Yes	Value fixed at "monitor"
PolicyName	string	Yes	Policy name, which can contain up to 20 characters
MonitorType	string	Yes	Monitor type. Valid values: MT_QCE (Converge Cloud service monitoring)
Namespace	string	Yes	Type of alarm policy, which can be obtained via DescribeAllNamespaces. For the monitoring of Converge Cloud services, the value of this parameter is `QceNamespacesNew.N.Id` of the output parameter of `DescribeAllNamespaces`, for example, `cvm_device`.
Remark	string	No	Remarks with up to 100 letters, digits, underscores, and hyphens
Enable	integer	No	Whether to enable. Valid values: 0 (no), 1 (yes). Default value: 1. This parameter can be left empty
ProjectId	integer	No	Project ID. For products with different projects, a value other than `-1` must be passed in. `-1`: no project; `0`: default project. If no value is passed in, `-1` will be used. The supported project IDs can be viewed on the Account Center > Project Management page of the console.
ConditionTemplateId	integer	No	Trigger condition template ID. Pass in this parameter if the policy is associated with the trigger condition template; otherwise, pass in the `Condition` parameter. The trigger condition template ID can be obtained via `DescribeConditionsTemplateList`.
Condition	AlarmPolicyCondition	No	Metric trigger condition. The supported metrics can be queried via DescribeAlarmMetrics.
EventCondition	AlarmPolicyEventCondition	No	Event trigger condition. The supported events can be queried via DescribeAlarmEvents.
NoticeIds	string[]	No	List of notification rule IDs, which can be obtained via DescribeAlarmNotices
TriggerTasks	AlarmPolicyTriggerTask[]	No	Triggered task list
Filter	AlarmPolicyFilter	No	Global filter.
GroupBy	string[]	No	Aggregation dimension list, which is used to specify which dimension keys data is grouped by.
Tags	Tag[]	No	Tags bound to a template
LogAlarmReqInfo	LogAlarmReq	No	Log alarm information
HierarchicalNotices	AlarmHierarchicalNotice[]	No	Notification rules for different alarm levels
MigrateFlag	integer	No	A dedicated field for migration policies. 0: Implement authentication logic; 1: Skip authentication logic.
EbSubject	string	No	The alert configured for an event

Response

Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.

Field	Type	Description
PolicyId	string	Alarm policy ID
OriginId	string	Alarm policy ID, which can be used when you call APIs (BindingPolicyObject, UnBindingAllPolicyObject, UnBindingPolicyObject) to bind/unbind instances or instance groups to/from an alarm policy
RequestId	string	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Success

{
  "Response": {
    "PolicyId": …,
    "OriginId": …,
    "RequestId": "…"
  }
}

Error

{
  "Response": {
    "Error": { "Code": "…", "Message": "…" },
    "RequestId": "…"
  }
}

Try it

CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/monitor.

SecretIdSecretKey

Request bodyvalid JSONPOST monitor.api3.convergecloud.com · CreateAlarmPolicy

{}

This action changes resources in my own account and may create a charge. I understand.

Recorded example response — captured 2026-09-16

{
  "Response": {
    "OriginId": "1838743",
    "PolicyId": "policy-vi1do18b",
    "RequestId": "ec253698-c640-e5b0-77dd-01ec5e617576"
  }
}