租户端 网络 私有网络（VPC） 高可用虚拟IP相关接口 查询HAVIP列表

查询HAVIP列表

最近更新时间: 2026-07-12 00:27:08

1. 接口描述

接口请求域名： vpc.api3.fincloud.tencent.com。

本接口（DescribeHaVips）用于查询高可用虚拟IP（HAVIP）列表。

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

接口更新时间：2025-08-15 19:35:15。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeHaVips
Version 是 否 String 公共参数，本接口取值：2017-03-12
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Offset 否 是 Uint64 偏移量，默认为0。

示例值： 0
Limit 否 是 Uint64 返回数量，默认为20，最大值为100。

示例值： 20
Business 否 是 String 产品业务名称，如TKE，SCF，NFV等。
示例值： NFV
IpAddressType 否 是 String 协议类型，支持 Ipv4，Ipv6，默认 Ipv4。
示例值： Ipv4
HaVipIds 否 是 Array of String HAVIP唯一ID，形如：havip-9o233uri。
示例值： ["havip-bk4275i0","havip-2kce8v4q"]
Filters 否 是 Array of Filter 过滤条件，参数不支持同时指定HaVipIds和Filters。
  • havip-id - String - HAVIP唯一ID，形如：havip-9o233uri。
  • havip-name - String - HAVIP名称。
  • vpc-id - String - HAVIP所在私有网络ID。
  • subnet-id - String - HAVIP所在子网ID。
  • vip - String - HAVIP的地址VIP。
  • address-ip - String - HAVIP绑定的弹性公网IP。
  • havip-association.instance-id - String - HAVIP绑定的子机或网卡。
  • havip-association.instance-type - String - HAVIP绑定的类型，取值:CVM, ENI。
  • check-associate - Bool - 是否开启HaVip飘移时校验绑定的子机或网卡。
  • cdc-id - String - CDC实例ID。

    • 示例值：查看

    3. 输出参数

    参数名称 类型 描述
    TotalCount Uint64 符合条件的对象数。
    示例值： 1
    HaVipSet Array of HaVip HAVIP对象数组。
    示例值：查看
    RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 错误码

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

    错误码 描述
    InvalidParameterValue.Malformed 入参格式不合法。
    InvalidParameter.Coexist 参数不支持同时指定。
    InvalidParameterValue.LimitExceeded 参数值超出限制。
    InvalidParameterValue.Range 参数值不在指定范围。
    InvalidParameterValue.TooLong 无效参数值。参数值太长。
    InvalidParameter.FilterInvalidKey
    InternalError.ModuleError