Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to modify a notification group.
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: ModifyAlarmNotice. |
| Version | Yes | String | Common Params. The value used for this API: 2020-10-16. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| AlarmNoticeId | Yes | String | Notification channel group ID. Obtain the notification channel group ID by searching the notification channel group list (https://www.tencentcloud.com/document/api/614/56462?from_cn_redirect=1). |
| Tags.N | No | Array of Tag | Tag description list. Tags can be bound to corresponding notification channel groups at the same time by specifying this parameter. It supports up to 10 tag key-value pairs, which cannot be duplicate. |
| Name | No | String | Notification group name |
| Type | No | String | Notification type. Optional Values: |
| NoticeReceivers.N | No | Array of NoticeReceiver | Notification recipient |
| WebCallbacks.N | No | Array of WebCallback | API callback information (including WeCom). |
| NoticeRules.N | No | Array of NoticeRule | Notification rulesNote: - Type, NoticeReceivers, and WebCallbacks are one set of configurations, while NoticeRules is another set of configurations. The two sets are mutually exclusive.- Submitting one set of data will nullify the other set. |
| JumpDomain | No | String | Call link domain name. It must start with http:// or https:// and must not end with /. |
| DeliverStatus | No | Integer | Delivery log switch. Parameter value: 1: disabled. 2: Enable |
| DeliverConfig | No | DeliverConfig | Log shipping configuration. |
| AlarmShieldStatus | No | Integer | Login-free operation alarm switch. Parameter value: 1: disabled 2: Enable (enabled by default) |
| CallbackPrioritize | No | Boolean | Unify the custom callback parameter settings. -true: Use the custom callback parameters in the notification content template to override the request header and request body separately configured in the alarm policy. -false: Prioritize using the request header and request body separately configured in the alarm policy. |
| Parameter Name | Type | Description |
|---|---|---|
| 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: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAlarmNotice
<Common request parameters>
{
"AlarmNoticeId": "notice-1a2c6c17-xxxx-xxxx-81be-25248ada5a4c",
"Name": "zhangsan-test-copy",
"JumpDomain": "https://xxxx.tent.com",
"NoticeRules": [
{
"NoticeReceivers": [
{
"ReceiverType": "Uin",
"ReceiverIds": [
11223344567
],
"ReceiverChannels": [
"Email"
],
"StartTime": "01:59:59",
"EndTime": "02:00:00",
"Index": 0,
"NoticeContentId": "Default-zh"
}
],
"WebCallbacks": [
{
"Headers": [],
"Method": "",
"Url": "http://xxx.com",
"CallbackType": "WeCom",
"Body": "",
"Index": 1,
"NoticeContentId": "Default-zh",
"WebCallbackId": "",
"RemindType": 0,
"Mobiles": [],
"UserIds": []
}
],
"Type": 1,
"Escalate": false,
"Interval": 10,
"Rule": "{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"NotifyType\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1,2]\",\"Type\":\"Value\"}]}]}"
}
],
"DeliverStatus": 1,
"AlarmShieldStatus": 1
}
{
"Response": {
"RequestId": "6ef60bec-xxxx-xxxx-bb20-270359fb54a7"
}
}
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 |
|---|---|
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameter.AlarmConflict | The alarm policy already exists. |
| InvalidParameter.AlarmNoticeConflict | The alarm notification template already exists. |
| MissingParameter | Missing parameter. |
| OperationDenied | Operation denied. |
| OperationDenied.ACLFailed | ACL verification failed. |
| OperationDenied.AccountDestroy | The account has been terminated. |
| OperationDenied.AccountIsolate | The account has overdue payments. |
| OperationDenied.AccountNotExists | The account does not exist. |
| ResourceNotFound.AlarmNoticeNotExist | The alarm notification template does not exist. |
文档反馈