tencent cloud

APIs

DocumentaçãoAPIsCloud Log ServiceAlarm Policy APIsCreateWebCallback

CreateWebCallback

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-06-10 15:03:22

1. API Description

Domain name for API request: cls.intl.tencentcloudapi.com.

This API is used to create alarm channel callback configurations.

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: CreateWebCallback.
Version Yes String Common Params. The value used for this API: 2020-10-16.
Region No String Common Params. This parameter is not required for this API.
Name Yes String Notification content name. Supports a maximum of 255 bytes.
Type Yes String Channel type.

WeCom: WeCom; DingTalk: DingTalk; Lark: Lark; Http: Custom Callback.
Webhook Yes String Webhook URL.
Method No String Request method. Support POST, PUT.

Required when Type is Http.
Key No String Secret key. Supports a maximum of 1024 bytes.

3. Output Parameters

Parameter Name Type Description
WebCallbackId String Callback configuration 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.

4. Example

Example1 This API is used to create alarm channel callback configurations.

This API is used to create alarm channel callback configurations.

Input Example

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

{
"Name": "Dedicated Monitoring Alarm"
    "Type": "WeCom",
    "Webhook": "http://www.xxx.com/send",
    "Method": "POST",
    "Key": "AADSHFYFNJKGYENGKVYDNGKFH<"
}

Output Example

{
    "Response": {
        "WebCallbackId": "webcallback-aaa-bbb-ccc-ddd",
        "RequestId": "abc-abc-abc-abc"
    }
}

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
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameter.AlarmNoticeConflict The alarm notification template already exists.
InvalidParameter.DbDuplication The unique key of database conflicts.
MissingParameter Missing parameter.
OperationDenied.AccountDestroy The account has been terminated.
OperationDenied.AccountIsolate The account has overdue payments.
OperationDenied.AccountNotExists The account does not exist.
Anterior: CreateNoticeContentPróximo: DeleteAlarmNotice

Ajuda e Suporte

Esta página foi útil?

comentários