1. 接口描述
接口请求域名： cdc.api3.fincloud.tencent.cn。
查询专用集群告警信息列表
默认接口请求频率限制：10次/秒。
接口更新时间：2023-06-13 10:54:59。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeDedicatedClusterAlarms |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-12-14 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| DedicatedClusterIds | 否 | 否 | Array of String | 集群id列表 示例值： ["cluster-nk6e8j6c"] |
| SearchRegions | 否 | 否 | Array of String | 查询地域列表 示例值： ["ap-zone1"] |
| AlarmStates | 否 | 否 | Array of String | 查询告警状态 示例值： ["NORMAL"] |
| StartTime | 否 | 否 | String | 查询告警开始时间 示例值： 2022-10-01 00:00:00 |
| EndTime | 否 | 否 | String | 查询告警结束时间 示例值： 2022-10-01 00:00:00 |
| Period | 否 | 否 | String | 查询最近多长时间 示例值： Week |
| Offset | 否 | 否 | Uint64 | 偏移量，默认为0。 示例值： 0 |
| Limit | 否 | 否 | Uint64 | 返回数量，默认为20 示例值： 20 |
| OrderField | 否 | 否 | Array of String | 排序的字段名称 示例值： ["AlarmState"] |
| Order | 否 | 否 | Array of String | 排序字段的升序或降序 示例值： ["Desc"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| HostInfoSet | Array of AlarmInfo | 告警信息列表 示例值：查看 |
| TotalCount | Uint64 | 告警总数 示例值： 9 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.InvalidAppIdFormat | ccdb返回结果不为0 |
| InvalidParameterValue.TooLong | 参数名过长 |
| ResourceNotFound.InvalidDedicatedClusterId | 该资源没有找到。 |
5. 示例
该接口暂无示例。