日志服务获取告警策略列表-告警策略相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： cls.tencentcloudapi.com 。

本接口用于获取告警策略列表。

默认接口请求频率限制：30次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeAlarms。
Version	是	String	公共参数，本接口取值：2020-10-16。
Region	是	String	公共参数，详见产品支持的地域列表。
Filters.N	否	Array of Filter	name - 按照【告警策略名称】进行过滤。 - 类型：String - 必选：否 alarmId - 按照【告警策略ID】进行过滤。 - 类型：String - 必选：否 topicId - 按照【监控对象的日志主题ID】进行过滤。 - 类型：String - 必选：否 enable - 按照【启用状态】进行过滤。 - 类型：String - 备注：enable参数值范围: 1, t, T, TRUE, true, True, 0, f, F, FALSE, false, False。其它值将返回参数错误信息. - 必选：否每次请求的Filters的上限为10，Filter.Values的上限为5。
Offset	否	Integer	分页的偏移量，默认值为0。示例值：1
Limit	否	Integer	分页单页限制数目，默认值为20，最大值100。示例值：1

参数名称	类型	描述
Alarms	Array of AlarmInfo	告警策略列表。
TotalCount	Integer	符合查询条件的告警策略数目。示例值：0
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

获取告警策略列表

POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAlarms
<公共请求参数>

{}

{
    "Response": {
        "TotalCount": 0,
        "Alarms": [],
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
    }
}

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.TagQpsLimit	请求标签服务限频。
OperationDenied	操作被拒绝。
OperationDenied.AccountDestroy	账户已销毁。
OperationDenied.AccountIsolate	账户欠费。
OperationDenied.AccountNotExists	账户不存在。
ResourceNotFound.TopicNotExist	日志主题不存在。