Domain name for API request: monitor.tencentcloudapi.com.
This API is used to create a notification template.
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: CreateAlarmNotice. |
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 |
Name | Yes | String | Notification template name, which can contain up to 60 characters |
NoticeType | Yes | String | Notification type. Valid values: ALARM (for unresolved alarms), OK (for resolved alarms), ALL (for all alarms) |
NoticeLanguage | Yes | String | Notification language. Valid values: zh-CN (Chinese), en-US (English) |
UserNotices.N | No | Array of UserNotice | User notifications (up to 5) |
URLNotices.N | No | Array of URLNotice | Callback notifications (up to 3) |
CLSNotices.N | No | Array of CLSNotice | The operation of pushing alarm notifications to CLS. Up to one CLS log topic can be configured. |
Tags.N | No | Array of Tag | Tags bound to a template |
Parameter Name | 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. |
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAlarmNotice
<Common request parameters>
{
"Module": "monitor",
"Name": "noticeA",
"NoticeType": "ALL",
"NoticeLanguage": "zh-CN",
"UserNotices": [
{
"ReceiverType": "USER",
"UserIds": [
10001
],
"NoticeWay": [
"SMS",
"EMAIL"
],
"StartTime": 0,
"EndTime": 1,
"PhoneOrder": [
10001
],
"PhoneCircleInterval": 60,
"PhoneCircleTimes": 2,
"PhoneInnerInterval": 60,
"NeedPhoneArriveNotice": 1,
"PhoneCallType": "CIRCLE"
}
],
"URLNotices": [
{
"URL": "https://www.mytest.com/validate"
}
]
}
{
"Response": {
"NoticeId": "notice-2h92ghf2",
"RequestId": "neh390an4opw0-45nw"
}
}
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?