DescribeAlarmNotices

Last updated: 2021-10-13 10:54:39

1. API Description

Domain name for API request: monitor.tencentcloudapi.com.

This API is used to query the list of notification templates.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeAlarmNotices.
Version Yes String Common parameter. The value used for this API: 2018-07-24.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
Module Yes String Module name. Enter "monitor" here
PageNumber Yes Integer Page number. Minimum value: 1
PageSize Yes Integer Number of entries per page. Value range: 1–200
Order Yes String Sort by update time. Valid values: ASC (ascending), DESC (descending)
OwnerUid No Integer Root account uid, which is used to create preset notifications
Name No String Alarm notification template name, which is used for fuzzy search
ReceiverType No String 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.N No Array of Integer Recipient object list
GroupIds.N No Array of Integer Recipient group list
NoticeIds.N No Array of String 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.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of alarm notification templates
Notices Array of AlarmNotice Alarm notification template list
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying notification template list

Input Example

POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAlarmNotices
<Common request parameters>

{
    "OwnerUid": 1234567,
    "Module": "monitor",
    "Name": "",
    "ReceiverType": "",
    "UserIds": [],
    "GroupIds": [],
    "PageNumber": 1,
    "PageSize": 20,
    "Order": "DESC"
}

Output Example

{
  "Response": {
    "Notices": [
      {
        "Id": "notice-lc0bjcrq",
        "Name": "System default notification template",
        "UpdatedAt": "2020-10-15 22:42:32",
        "UpdatedBy": "789789789",
        "NoticeType": "ALL",
        "UserNotices": [
          {
            "ReceiverType": "USER",
            "UserIds": [
              1234567
            ],
            "GroupIds": null,
            "StartTime": 0,
            "EndTime": 86399,
            "NoticeWay": [
              "SMS",
              "EMAIL"
            ],
            "PhoneOrder": null,
            "PhoneCircleTimes": 0,
            "PhoneInnerInterval": 0,
            "PhoneCircleInterval": 0,
            "NeedPhoneArriveNotice": 0
          }
        ],
        "URLNotices": [],
        "IsPreset": 1,
        "NoticeLanguage": "zh-CN",
        "PolicyIds": []
      }
    ],
    "RequestId": "mcy414ov4yom5l9lcam6phul347qqv41",
    "TotalCount": 1
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure Error with CAM signature/authentication.
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue The parameter value is incorrect.
ResourceNotFound The resource is not found.
UnsupportedOperation Unsupported operation.