查询告警策略列表

最近更新时间: 2026-09-17 00:06:28

1. 接口描述

接口请求域名： monitor.api3.fincloud.tencent.cn。

查询告警策略列表

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

接口更新时间：2025-07-22 18:09:06。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeAlarmPolicies
Version	是	否	String	公共参数，本接口取值：2018-07-24
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Module	是	否	String	固定值，为"monitor" 示例值： monitor
PageNumber	否	否	Int64	页数，从 1 开始计数，默认 1 示例值： 1
PageSize	否	否	Int64	每页的数量，取值1~100，默认20 示例值： 20
PolicyName	否	否	String	按策略名称模糊搜索示例值： policy-24sxe890
MonitorTypes	否	否	Array of String	根据监控类型过滤不选默认查所有类型 "MT_QCE"=云产品监控示例值： ["MT_QCE"]
Namespaces	否	否	Array of String	根据命名空间过滤示例值： ["cvm_device"]
Measurements	否	否	Array of String	根据策略类型（viewName）过滤（云产品监控用）示例值： [cvm]
Dimensions	否	否	String	告警对象列表示例值： [[{"name":"unInstanceId","value":"ins-qr888845g"}]]
ReceiverUids	否	否	Array of Int64	根据接收人搜索示例值： [9989]
ReceiverGroups	否	否	Array of Int64	根据接收组搜索示例值： [1112]
PolicyType	否	否	Array of String	根据默认策略筛选不传展示全部策略 DEFAULT=展示默认策略 NOT_DEFAULT=展示非默认策略示例值： ["DEFAULT"]
Field	否	否	String	排序字段示例值： PolicyId
Order	否	否	String	排序顺序：升序：ASC 降序：DESC 示例值： DESC
ProjectIds	否	否	Array of Int64	项目id数组示例值： [1]
AlarmStatus	否	否	Array of Int64	字段废弃，启停，1：启用 0：停止示例值： [1]
NoticeIds	否	否	Array of String	告警通知id列表示例值： [1,2]
RuleTypes	否	否	Array of String	根据触发条件筛选不传展示全部策略 STATIC=展示静态阈值策略 DYNAMIC=展示动态阈值策略示例值： [STATIC]
Enable	否	否	Array of Int64	启停，1：启用 0：停止示例值： 1
NotBindingNoticeRule	否	否	Int64	是否未配置通知规则，1：未配置，0：配置示例值： 1
InstanceGroupId	否	否	Int64	实例组id 示例值： 1
ConditionTemplateId	否	否	Int64	条件模板id 示例值： 1
Like	否	否	String	模糊匹配示例值：已废弃
Limit	否	否	String	限制示例值： 10
Offset	否	否	Int64	偏移量示例值： 0
AlarmLevels	否	否	Array of String	告警等级示例值： Remind

3. 输出参数

参数名称	类型	描述
TotalCount	Int64	策略总数示例值： 100
Policies	Array of AlarmPolicy	策略数组示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
UnsupportedOperation	操作不支持。
InternalError	内部错误。
FailedOperation	操作失败。

5. 示例

示例1 查询告警策略列表

输入示例

POST / HTTP/1.1
Host: monitor.api3.fincloud.tencent.cn
Content-Type: application/json
X-TC-Action: DescribeAlarmPolicies
https://monitor.api3.fincloud.tencent.cn/?Action=DescribeAllNamespaces&Module="monitor"&SceneType="1598976507"&ids="1598976507"&MonitorTypes="1000000"
&<公共请求参数>

<公共请求参数>

{
  "Module": "monitor",
  "PolicyName":"policy",
  "PageSize":10,
  "PageNumber":1
}

输出示例

{
    "Response":{
        "Policies":[
            {
                "PolicyId":"policy-pvnj4u7h",
                "PolicyName":"Test-2",
                "UseSum":0,
                "Remark":"For-Test-2",
                "MonitorType":"MT_QCE",
                "Enable":1,
                "IsDefault":0,
                "ProjectId":0,
                "ProjectName":"",
                "Namespace":"cvm_device",
                "PolicyExpression":"",
                "ConditionTemplateId":"",
                "Condition":{
                    "IsUnionRule":0,
                    "Rules":[
                        {
                            "MetricName":"CpuUsage",
                            "Description":"CPU利用率",
                            "Period":60,
                            "Operator":"gt",
                            "Value":"0",
                            "ContinuePeriod":1,
                            "NoticeFrequency":86400,
                            "IsPowerNotice":0,
                            "Filter":{
                                "Type":"",
                                "Expression":"",
                                "Dimensions":"[]"
                            }
                        }
                    ]
                },
                "EventCondition":{
                    "Rules":[

                    ]
                },
                "NoticeIds":[
                    "notice-esrwma09"
                ],
                "Notices":[
                    {
                        "Id":"notice-esrwma09",
                        "Name":"Notice-Test-2",
                        "UpdatedAt":"2020-10-19 20:56:50",
                        "UpdatedBy":"1500000685",
                        "NoticeType":"OK",
                        "UserNotices":[
                            {
                                "ReceiverType":"GROUP",
                                "UserIds":null,
                                "GroupIds":[
                                    3877
                                ],
                                "StartTime":0,
                                "EndTime":1,
                                "NoticeWay":[
                                    "EMAIL"
                                ],
                                "PhoneOrder":null,
                                "PhoneCircleTimes":2,
                                "PhoneInnerInterval":60,
                                "PhoneCircleInterval":60,
                                "NeedPhoneArriveNotice":1
                            }
                        ],
                        "URLNotices":[
                            {
                                "URL":"https://www.abc.com",
                                "IsValid":0
                            }
                        ],
                        "IsPreset":0
                    }
                ],
                "TriggerTasks":[

                ],
                "OriginId":"1314081",
                "ConditionsTemp":{
                    "ConditionId":0,
                    "TemplateName":"",
                    "Condition":null,
                    "EventCondition":null
                },
                "LastEditUin":"1500000685",
                "UpdateTime":1603114100,
                "InsertTime":1603114100,
                "Region":[
                    "bj",
                    "ca",
                    "cd",
                    "cq",
                    "de",
                    "fzec",
                    "gz",
                    "gzopen",
                    "hk",
                    "hzec",
                    "in",
                    "jnec",
                    "jp",
                    "kr",
                    "nj",
                    "ru",
                    "sg",
                    "sh",
                    "shjr",
                    "szjr",
                    "szx",
                    "th",
                    "tpe",
                    "tsn",
                    "use",
                    "usw"
                ],
                "NamespaceShowName":"云服务器-基础监控",
                "CanSetDefault":1,
                "InstanceGroupId":0,
                "InstanceGroupName":"",
                "InstanceSum":0
            }
        ],
        "RequestId":"p7gicv4fb-4euztbaaczrsj4vz-s28g-",
        "TotalCount":2
    }
}