monitor · 2018-07-24

DescribeAlarmNotices

POST

Query the list of notification templates.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /monitor/DescribeAlarmNotices 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: DescribeAlarmNotices' \
  -H 'X-TC-Version: 2018-07-24' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"Module":"<Module>","PageNumber":1,"PageSize":1,"Order":"<Order>"}'

Request parameters

Field	Type	Required	Description
Module	string	Yes	Module name. Enter "monitor" here
PageNumber	integer	Yes	Page number. Minimum value: 1
PageSize	integer	Yes	Number of entries per page. Value range: 1–200
Order	string	Yes	Sort by update time. Valid values: ASC (ascending), DESC (descending)
OwnerUid	integer	No	Root account `uid`, which is used to create preset notifications
Name	string	No	Alarm notification template name, which is used for fuzzy search
ReceiverType	string	No	Filter by recipient. The type of notified users should be selected for the alarm notification template. Valid values: USER (user), GROUP (user group). If this parameter is left empty, no filter by recipient will be performed
UserIds	string[]	No	Recipient object list
GroupIds	string[]	No	Recipient group list
NoticeIds	string[]	No	Filter by notification template ID. If an empty array is passed in or if this parameter is left empty, the filter operation will not be performed.
Tags	Tag[]	No	Filter templates by tag
OnCallFormIDs	string[]	No	Schedule list

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
TotalCount	integer	Total number of alarm notification templates
Notices	AlarmNotice[]	Alarm notification template list
RequestId	string	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Success

{
  "Response": {
    "TotalCount": …,
    "Notices": …,
    "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 · DescribeAlarmNotices

{
  "Module": "<Module>",
  "PageNumber": 1,
  "PageSize": 1,
  "Order": "<Order>"
}

Read-only. Creates nothing.

Recorded example response — captured 2026-09-16

{
  "Response": {
    "Notices": [
      {
        "Id": "notice-57nmre36",
        "Name": "系统预设通知模板",
        "UpdatedAt": "2026-09-16 19:47:35",
        "UpdatedBy": "100000000001",
        "NoticeType": "ALL",
        "NoticeLanguage": "zh-CN",
        "UserNotices": [
          {
            "ReceiverType": "USER",
            "UserIds": [
              0
            ],
            "GroupIds": null,
            "StartTime": 0,
            "EndTime": 86399,
            "NoticeWay": [
              "SMS",
              "EMAIL"
            ],
            "PhoneOrder": null,
            "PhoneCircleTimes": 0,
            "PhoneInnerInterval": 0,
            "PhoneCircleInterval": 0,
            "NeedPhoneArriveNotice": 0
          }
        ],
        "URLNotices": [],
        "BigCustomerNotices": [],
        "IsPreset": 1,
        "PolicyIds": null,
        "AMPConsumerId": "Consumer-wswylb1zcc",
        "ExtraChannels": []
      }
    ],
    "RequestId": "fbc01eaa-0f44-7f10-d7bc-92640a65ce9d",
    "TotalCount": 1
  }
}

Behaviour

Order is required in addition to the paging parameters.