私有网络 查询HAVIP列表 - API文档

1. 接口描述

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

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

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

注意：本接口支持金融区地域。由于金融区和非金融区是隔离不互通的，因此当公共参数 Region 为金融区地域（例如 ap-shanghai-fsi）时，需要同时指定带金融区地域的域名，最好和 Region 的地域保持一致，例如：vpc.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

3. 输出参数

4. 示例

示例1 按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列表

输入示例

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。

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++
• Tencent Cloud SDK 3.0 for Ruby

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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