tencent cloud

文档反馈

CreateAlarmNotice

最后更新时间:2023-08-11 16:09:10

1. API Description

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.

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 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

3. Output Parameters

Parameter Name Type Description
NoticeId String Alarm notification template ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a notification template

Input Example

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"
        }
    ]
}

Output Example

{
    "Response": {
        "NoticeId": "notice-2h92ghf2",
        "RequestId": "neh390an4opw0-45nw"
    }
}

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.
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.
联系我们

联系我们,为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持