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.
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 Params. The value used for this API: DescribeAlarmNotices. |
Version | Yes | String | Common Params. The value used for this API: 2018-07-24. |
Region | No | String | Common Params. This parameter is not required. |
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. |
Tags.N | No | Array of Tag | Filter templates by tag |
OnCallFormIDs.N | No | Array of String | Schedule list |
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. |
This example shows you how to query the notification template list.
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",
"NoticeIds": [
"notice-ah28cv9d"
]
}
{
"Response": {
"TotalCount": 0,
"Notices": [
{
"Id": "abc",
"Name": "abc",
"UpdatedAt": "abc",
"UpdatedBy": "abc",
"NoticeType": "abc",
"UserNotices": [
{
"ReceiverType": "abc",
"UserIds": [
0
],
"GroupIds": [
0
],
"StartTime": 0,
"EndTime": 0,
"NoticeWay": [
"abc"
],
"PhoneOrder": [
0
],
"PhoneCircleTimes": 0,
"PhoneInnerInterval": 0,
"PhoneCircleInterval": 0,
"NeedPhoneArriveNotice": 0,
"PhoneCallType": "abc",
"Weekday": [
0
],
"OnCallFormIDs": [
"abc"
]
}
],
"URLNotices": [
{
"URL": "abc",
"IsValid": 0,
"ValidationCode": "abc",
"StartTime": 0,
"EndTime": 0,
"Weekday": [
0
]
}
],
"IsPreset": 0,
"NoticeLanguage": "abc",
"PolicyIds": [
"abc"
],
"AMPConsumerId": "abc",
"CLSNotices": [
{
"Enable": 0,
"Region": "abc",
"LogSetId": "abc",
"TopicId": "abc"
}
],
"Tags": [
{
"Key": "abc",
"Value": "abc"
}
]
}
],
"RequestId": "abc"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
FailedOperation.DoHTTPTransferFailed | Backend service timed out. |
InternalError | Internal error. |
InvalidParameter | Invalid parameter. |
InvalidParameterValue | The parameter value is incorrect. |
ResourceNotFound | The resource is not found. |
UnsupportedOperation | Unsupported operation. |
Was this page helpful?