查询通知模板列表
最近更新时间: 2024-09-03 18:49:57
1. 接口描述
接口请求域名： monitor.api3.cloud.sunhongs.com。
查询通知模板列表
默认接口请求频率限制：20次/秒。
接口更新时间：2022-11-22 16:04:12。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeAlarmNotices |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-07-24 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| Module | 是 | 否 | String | 模块名，这里填“monitor” |
| OwnerUid | 否 | 否 | Int64 | 主账号 uid 用于创建预设通知 |
| Name | 否 | 否 | String | 告警通知模板名称 用来模糊搜索 |
| ReceiverType | 否 | 否 | String | 根据接收人过滤告警通知模板需要选定通知用户类型 USER=用户 GROUP=用户组 传空=不按接收人过滤 |
| UserIds | 否 | 否 | Array of Int64 | 接收对象列表 |
| GroupIds | 否 | 否 | Array of Int64 | 接收组列表 |
| PageNumber | 是 | 否 | Int64 | 页码 最小为1 |
| PageSize | 是 | 否 | Int64 | 分页大小 1～200 |
| Order | 是 | 否 | String | 按更新时间排序方式 ASC=正序 DESC=倒序 |
| AMPConsumerIds | 否 | 否 | Array of String | 根据后台 amp consumer id 列表过滤，传空不过滤 |
| NoticeIds | 否 | 否 | Array of String | 根据通知模板 id 过滤，空数组/不传则不过滤 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Int64 | 此参数对外不可见。 告警通知模板总数 |
| Notices | AlarmNotice | 此参数对外不可见。 告警通知模板列表 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | |
| InvalidParameter | |
| ResourceNotFound | |
| FailedOperation | |
| UnsupportedOperation | |
| AuthFailure.UnauthorizedOperation | |
| InvalidParameterValue |