查询HAVIP列表
最近更新时间: 2024-10-18 10:38:48
1. 接口描述
接口请求域名： vpc.api3.fincloud.tencent.cn。
本接口（DescribeHaVips）用于查询高可用虚拟IP（HAVIP）列表。
默认接口请求频率限制：20次/秒。
接口更新时间：2019-12-19 18:05:25。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeHaVips |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| HaVipIds | 否 | 否 | Array of String | HAVIP唯一ID，形如：havip-9o233uri。 |
| Filters | 否 | 否 | Array of Filter | 过滤条件，参数不支持同时指定HaVipIds和Filters。<br><li>havip-id - String - HAVIP唯一ID，形如：havip-9o233uri。</li><br><li>havip-name - String - HAVIP名称。</li><br><li>vpc-id - String - HAVIP所在私有网络ID。</li><br><li>subnet-id - String - HAVIP所在子网ID。</li><br><li>address-ip - String - HAVIP绑定的弹性公网IP。</li> |
| Offset | 否 | 否 | Uint64 | 偏移量 |
| Limit | 否 | 否 | Uint64 | 返回数量 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Uint64 | 此参数对外不可见。 符合条件的对象数。 |
| HaVipSet | HaVip | 此参数对外不可见。HAVIP对象数组。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.Malformed | |
| InvalidParameter.Coexist |