查询告警策略列表

最近更新时间: 2025-04-01 17:27:11

1. 接口描述

接口请求域名： monitor.api3.gsesgpucloud.com。

查询告警策略列表

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

接口更新时间：2022-06-28 11:20:11。

接口既验签名又鉴权。

2. 输入参数

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

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

3. 输出参数

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

4. 错误码

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

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