monitor · 2018-07-24

CreateAlarmNotice

POST

Create a notification template.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /monitor/CreateAlarmNotice 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: CreateAlarmNotice' \
  -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	Module name. Enter "monitor" here
Name	string	Yes	Notification template name, which can contain up to 60 characters
NoticeType	string	Yes	Notification type. Valid values: ALARM (for unresolved alarms), OK (for resolved alarms), ALL (for all alarms)
NoticeLanguage	string	Yes	Notification language. Valid values: zh-CN (Chinese), en-US (English)
UserNotices	UserNotice[]	No	User notifications (up to 5)
URLNotices	URLNotice[]	No	Callback notifications (up to 3)
CLSNotices	CLSNotice[]	No	The operation of pushing alarm notifications to CLS. Up to one CLS log topic can be configured.
Tags	Tag[]	No	Tags bound to a template

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
NoticeId	string	Alarm notification template ID
RequestId	string	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Success

{
  "Response": {
    "NoticeId": …,
    "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 · CreateAlarmNotice

{}

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

Recorded example response — captured 2026-09-16

{
  "Response": {
    "NoticeId": "notice-loayqojc",
    "RequestId": "8f8e84e4-cd33-c64d-c3f1-c623397ec8d3"
  }
}