租户端 计算 裸金属服务器（BMS） 裸金属服务 DescribeHeartbeats

DescribeHeartbeats

最近更新时间: 2025-03-12 16:34:37

1. 接口描述

接口请求域名： bms.api3.gds-cloud.com。

查询心跳网络组信息

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

接口更新时间：2023-08-29 22:19:34。

接口既验签名又鉴权。

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。参数不支持同时指定HeartbeatIds和Filters。
    示例值：查看
    Offset 否 否 Uint64 偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
    示例值： 0
    Limit 否 否 Uint64 返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
    示例值： 1

    3. 输出参数

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

    4. 错误码

    该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。