有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

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

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeHaVips。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
HaVipIds.N Array of String HAVIP唯一ID,形如:havip-9o233uri
示例值:["havip-bk4275i0\r\n","havip-2kce8v4q\r\n"]
Filters.N Array of Filter 过滤条件,参数不支持同时指定HaVipIdsFilters
  • 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
  • Offset Integer 偏移量,默认为0。

    示例值:0
    Limit Integer 返回数量,默认为20,最大值为100。

    示例值:20

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的对象数。
    示例值:2
    HaVipSet Array of HaVip HAVIP对象数组。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 按ID过滤查询HAVIP列表

    按ID过滤查询HAVIP列表

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeHaVips
    &HaVipIds.0=havip-bk4275i0
    &HaVipIds.1=havip-2kce8v4q
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "HaVipSet": [
                {
                    "HaVipId": "havip-2kce8v4q",
                    "HaVipName": "tadfafd",
                    "Vip": "10.3.3.15",
                    "VpcId": "vpc-o31qeah3",
                    "SubnetId": "subnet-8qywqc4y",
                    "NetworkInterfaceId": "",
                    "InstanceId": "",
                    "AddressIp": "",
                    "Business": "",
                    "State": "UNBOUND",
                    "CreatedTime": "2018-04-03 20:00:05"
                },
                {
                    "HaVipId": "havip-bk4275i0",
                    "HaVipName": "22",
                    "Vip": "10.2.0.14",
                    "VpcId": "vpc-2mcdauzl",
                    "SubnetId": "subnet-mnmm19fg",
                    "NetworkInterfaceId": "",
                    "InstanceId": "",
                    "AddressIp": "",
                    "Business": "",
                    "State": "UNBOUND",
                    "CreatedTime": "2018-04-03 20:05:33"
                }
            ],
            "TotalCount": 2,
            "RequestId": "1c827bf1-837f-4302-b51a-4d538b7ad249"
        }
    }

    示例2 多条件过滤查询HAVIP列表

    多条件过滤查询HAVIP列表

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeHaVips
    &Filters.0.Name=havip-name
    &Filters.0.Values.0=test
    &Filters.1.Name=vpc-id
    &Filters.1.Values.0=vpc-6v2ht8q5
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "HaVipSet": [
                {
                    "HaVipId": "havip-iyy1ykky",
                    "HaVipName": "test modify",
                    "Vip": "10.4.6.17",
                    "VpcId": "vpc-6v2ht8q5",
                    "SubnetId": "subnet-qq51iwr4",
                    "NetworkInterfaceId": "",
                    "InstanceId": "",
                    "AddressIp": "",
                    "Business": "",
                    "State": "UNBOUND",
                    "CreatedTime": "2018-10-09 18:08:16"
                }
            ],
            "TotalCount": 1,
            "RequestId": "659cd6a3-a75a-473c-8280-af27c33da8bd"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

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

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