获取基础策略告警组列表
最近更新时间: 2024-10-18 10:38:30
1. 接口描述
接口请求域名： monitor.api3.fincloud.tencent.cn。
获取基础策略告警组列表
默认接口请求频率限制：20次/秒。
接口更新时间：2022-10-24 10:18:55。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribePolicyGroupList |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-07-24 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| Module | 是 | 否 | String | 固定值，为"monitor" |
| Limit | 是 | 否 | Int64 | 分页参数，每页返回的数量，取值1~100 |
| Offset | 是 | 否 | Int64 | 分页参数，页偏移量，从0开始计数 |
| Like | 否 | 否 | String | 按策略名搜索 |
| InstanceGroupId | 否 | 否 | Int64 | 实例分组id |
| UpdateTimeOrder | 否 | 否 | String | 按更新时间排序, asc 或者 desc |
| ProjectIds | 否 | 否 | Array of Int64 | 项目id列表 |
| ViewNames | 否 | 否 | Array of String | 告警策略类型列表 |
| FilterUnuseReceiver | 否 | 否 | Int64 | 是否过滤无接收人策略组, 1表示过滤, 0表示不过滤 |
| Receivers | 否 | 否 | Array of String | 过滤条件, 接收组列表 |
| ReceiverUserList | 否 | 否 | Array of String | 过滤条件, 接收人列表 |
| Dimensions | 否 | 否 | String | 维度组合字段(json字符串), 例如[[{"name":"unInstanceId","value":"ins-6e4b2aaa"}]] |
| ConditionTempGroupId | 否 | 否 | String | 模板策略组id, 多个id用逗号分隔 |
| ReceiverType | 否 | 否 | String | 过滤条件, 接收人或者接收组, user表示接收人, group表示接收组 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| GroupList | DescribePolicyGroupListGroup | 策略组列表 |
| Total | Int64 | 策略组总数 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | |
| InternalError | |
| InvalidParameter.InvalidParameterParam | |
| InvalidParameter.InvalidParameter | |
| InvalidParameter | |
| InternalError.ExeTimeout | |
| FailedOperation | |
| MissingParameter | |
| UnknownParameter | |
| UnauthorizedOperation | |
| UnsupportedOperation | |
| ResourceNotFound | |
| LimitExceeded | |
| ResourceUnavailable | |
| ResourceInsufficient | |
| FailedOperation | |
| ResourceInUse | |
| DryRunOperation | |
| ResourcesSoldOut | |
| LimitExceeded.MetricQuotaExceeded | |
| FailedOperation.ServiceNotEnabled | |
| FailedOperation.AlertPolicyCreateFailed | |
| FailedOperation.DbRecordCreateFailed | |
| FailedOperation.DbTransactionBeginFailed | |
| FailedOperation.DbRecordDeleteFailed | |
| FailedOperation.DbQueryFailed | |
| FailedOperation.DbTransactionCommitFailed | |
| FailedOperation.DbRecordUpdateFailed | |
| AuthFailure.UnauthorizedOperation | |
| FailedOperation.DuplicateName | |
| FailedOperation.DruidQueryFailed | |
| FailedOperation.DimQueryRequestFailed | |
| FailedOperation.AlertPolicyDescribeFailed | |
| FailedOperation.AlertPolicyDeleteFailed | |
| FailedOperation.AlertPolicyModifyFailed | |
| FailedOperation.AlertTriggerRuleDeleteFailed | |
| FailedOperation.AlertFilterRuleDeleteFailed |