查询心跳网络组信息

最近更新时间: 2026-11-07 00:16:28

1. 接口描述

接口请求域名： bms.api3.fincloud.tencent.cn。

查询心跳网络组信息

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

接口更新时间：2025-12-30 16:30:08。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeHeartbeats
Version	是	否	String	公共参数，本接口取值：2018-08-13
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
HeartbeatIds	否	否	Array of String	心跳网络组ID 示例值： HB-adsfghjk
Filters	否	否	Array of Filter	过滤条件。 Name - String - 是否必填：否 -（过滤条件）按照名称过滤。 VlanId - String - 是否必填：否 -（过滤条件）按照vlanid过滤。每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。参数不支持多项联合查询。示例值：查看
Offset	否	否	Uint64	偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介]中的相关小节。示例值： 0
Limit	否	否	Uint64	返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介]中的相关小节。示例值： 20

3. 输出参数

参数名称	类型	描述
HeartbeatSet	Array of HeartbeatSet	心跳网络组详细信息示例值：查看
TotalCount	Uint64	心跳网络组条目数示例值： 100
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
InvalidParameterValue.HeartbeatIdMalformed	心跳组格式不正确
InvalidParameterValue.InvalidFilter	无效的过滤器。

5. 示例

示例1 查询心跳网络组信息

输入示例

{"Offset":0,"Limit":20,"Version":"2018-08-13","Language":"zh-CN"}

输出示例

{
        "Response": {
            "HeartbeatSet": [
                {
                    "HeartbeatId": "HB-8de54c40",
                    "Name": "1",
                    "VlanId": "1000",
                    "CurrentNum": 0,
                    "CreatedTime": "2026-03-16 16:48:56",
                    "CreateTimeIso": "2026-03-16T16:48:56+08:00"
                },
                {
                    "HeartbeatId": "HB-c8110f10",
                    "Name": "2",
                    "VlanId": "1001",
                    "CurrentNum": 0,
                    "CreatedTime": "2026-03-16 16:48:58",
                    "CreateTimeIso": "2026-03-16T16:48:58+08:00"
                }
            ],
            "TotalCount": 2,
            "RequestId": "c4423251-90e2-8088-da3d-50f4cd13e5e8"
        }
    }