Release Notes and Announcements

Release Notes

Announcements

User Guide

Product Introduction

Overview

Features

Available Regions

Limits

Concepts

Service Regions and Service Providers

Purchase Guide

Billing Overview

Product Pricing

Pay-as-You-Go

Billing

Cleaning up CLS resources

Cost Optimization

FAQs

Getting Started

Getting Started in 1 Minute

Getting Started Guide

Quickly Trying out CLS with Demo

Operation Guide

Resource Management

Permission Management

Log Collection

Metric Collection

Log Storage

Metric Storage

Search and Analysis (Log Topic)

Search and Analysis (Metric Topic)

Dashboard

Data Processing documents

Shipping and Consumption

Monitoring Alarm

Cloud Insight

Independent DataSight console

Historical Documentation

Practical Tutorial

Log Collection

Search and Analysis

Dashboard

Monitoring Alarm

Shipping and Consumption

Cost Optimization

Developer Guide

Embedding CLS Console

CLS Connection to Grafana

API Documentation

History

Introduction

API Category

Making API Requests

Topic Management APIs

Log Set Management APIs

Index APIs

Topic Partition APIs

Machine Group APIs

Collection Configuration APIs

Log APIs

Metric APIs

Alarm Policy APIs

Data Processing APIs

Kafka Protocol Consumption APIs

CKafka Shipping Task APIs

Kafka Data Subscription APIs

COS Shipping Task APIs

SCF Delivery Task APIs

Scheduled SQL Analysis APIs

COS Data Import Task APIs

Data Types

Error Codes

FAQs

Health Check

Collection

Log Search

Others

CLS Service Level Agreement

CLS Policy

Data Processing And Security Agreement

Glossary

CreateAlarmNotice

PDF

Focus Mode

Font Size

Last updated: 2025-11-13 20:47:38

1. API Description

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

This API is used to create a notification group.

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: 2020-10-16.
Region	No	String	Common Params. This parameter is not required for this API.
Name	Yes	String	Notification group name
Type	No	String	Notification type. Optional Values: Trigger - Alarm triggered Recovery - Alarm recovery All - Alarm triggered and alarm recovery
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 form one set of configurations, and NoticeRules form another set. The two sets of configurations are mutually exclusive.

3. Output Parameters

Parameter Name	Type	Description
AlarmNoticeId	String	Alarm 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.

4. Example

Example1 Creating a Notification Group

Input Example

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

{
    "Name": "test",
    "Type": "All",
    "WebCallbacks": [
        {
            "CallbackType": "Http",
            "Url": "http://www.testnotice.com/callback",
            "Method": "POST"
        }
    ]
}

Output Example

{
    "Response": {
        "AlarmNoticeId": "xxxx-xx-xx-xx-xxxxxxxx",
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
    }
}

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

Tencent Cloud CLI 3.0

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.
MissingParameter	Missing parameter.
OperationDenied.AccountDestroy	The account has been terminated.
OperationDenied.AccountIsolate	The account has overdue payments.
OperationDenied.AccountNotExists	The account does not exist.

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

Cloud Log Service