tencent cloud

日志服务

动态与公告
产品动态
公告
新手指引
产品简介
产品概述
产品优势
地域和访问域名
规格与限制
基本概念
购买指南
计费概述
产品定价
按量计费(后付费)
欠费说明
清理日志服务资源
成本优化
常见问题
快速入门
一分钟入门指南
入门指南
使用 Demo 日志快速体验 CLS
操作指南
资源管理
权限管理
日志采集
指标采集
日志存储
指标存储
检索分析(日志主题)
检索分析(指标主题)
仪表盘
数据处理
投递与消费
监控告警
云产品中心
DataSight 独立控制台
历史文档
实践教程
日志采集
检索分析
仪表盘
监控告警
投递和消费
成本优化
开发者指南
通过 iframe 内嵌 CLS(旧方案)
通过 Grafana 使用 CLS
API 文档
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
常见问题
健康监测问题解释
采集相关
检索分析相关
其他问题
服务等级协议
CLS 政策
隐私协议
数据处理和安全协议
联系我们
词汇表

DescribeAlarmNotices

PDF
聚焦模式
字号
最后更新时间: 2025-11-13 20:47:36

1. API Description

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

This API is used to get the notification group list.

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: DescribeAlarmNotices.
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.
Filters.N No Array of Filter
  • name
    Filter by Notification Channel Group Name.Type: String
    Required: No
  • alarmNoticeId
    Filter by Notification Channel Group ID.Type: String
    Required: No
  • uid
    Filter by Receiving User ID.Type: String
    Required: No
  • groupId
    Filter by Receiving User Group ID.Type: String
    Required: No


  • deliverFlag
    Filter by Delivery Status.Type: String
    Required: No
    Optional Values: "1": Not Enabled, "2": Enabled, "3": Delivery Exception
  • The maximum number of Filters per request is 10, and the maximum for Filter.Values is 5.
    Offset No Integer Page offset. Default value: 0
    Limit No Integer Maximum number of entries per page. Default value: 20. Maximum value: 100.

    3. Output Parameters

    Parameter Name Type Description
    AlarmNotices Array of AlarmNotice Alarm notification template list
    Note: this field may return null, indicating that no valid values can be obtained.
    TotalCount Integer Total number of eligible alarm notification templates
    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 Getting the Notification Group List

    Input Example

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

    Output Example

    {
        "Response": {
            "TotalCount": 0,
            "AlarmNotices": [],
            "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

    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.TagQpsLimit The frequency of tag service requests is limited.
    InternalError Internal error.
    InvalidParameter Incorrect parameter.
    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.

    帮助和支持

    本页内容是否解决了您的问题?

    填写满意度调查问卷,共创更好文档体验。

    文档反馈