查询心跳网络组信息
最近更新时间: 2024-06-18 14:31:22
1. 接口描述
接口请求域名： bms.api3.fincloud.tencent.cn。
查询心跳网络组信息
默认接口请求频率限制：20次/秒。
接口更新时间：2023-08-29 22:19:34。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeHeartbeats |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-08-13 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| HeartbeatIds | 否 | 否 | Array of String | 心跳网络组ID |
| Filters | 否 | 否 | Array of Filter | 过滤条件。<li> Name - String - 是否必填：否 -（过滤条件）按照名称过滤。</li><li> VlanId - String - 是否必填：否 -（过滤条件）按照vlanid过滤。</li>每次请求的Filters的上限为10，Filter.Values的上限为5。参数不支持同时指定HeartbeatIds和Filters。 |
| Offset | 否 | 否 | Uint64 | 偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。 |
| Limit | 否 | 否 | Uint64 | 返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| HeartbeatSet | HeartbeatSet | 心跳网络组详细信息 |
| TotalCount | Uint64 | 心跳网络组条目数 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。