边缘计算机器查询HAVIP列表

1. 接口描述

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

用于查询高可用虚拟IP（HAVIP）列表。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeHaVips。
Version	是	String	公共参数，本接口取值：2019-07-19。
Region	否	String	公共参数，本接口不需要传递此参数。
HaVipIds.N	否	Array of String	HAVIP数组，HAVIP唯一ID，形如：havip-9o233uri。示例值：["havip-bk4275i0","havip-2kce8v4q"]
Filters.N	否	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。示例值：[{"Name": "vpc-id", "Values": ["vpc-ms7c7gcr"]}]
Offset	否	Integer	偏移量，默认值是0。示例值：0
Limit	否	Integer	返回数量，默认值是20，最大是100。示例值：10
EcmRegion	否	String	Ecm 区域，不填代表全部区域。示例值：1

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	符合条件的对象数。示例值：1
HaVipSet	Array of HaVip	HAVIP对象数组。示例值：[{"HaVipId":"havip-2kce8v4q","HaVipName":"demo","VpcId":"vpc-ms7c7gcr","Vip":"10.3.3.15","SubnetId":"subnet-6zwa44xm"}]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

输入示例

POST / HTTP/1.1
Host: ecm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeHaVips
<公共请求参数>

{
    "HaVipIds": [
        "havip-bk4275i0",
        "havip-2kce8v4q"
    ]
}

输出示例

{
    "Response": {
        "HaVipSet": [
            {
                "HaVipId": "havip-2kce8v4q",
                "HaVipName": "tadfafd",
                "Vip": "10.3.3.15",
                "VpcId": "vpc-11111111",
                "SubnetId": "subnet-11111111",
                "NetworkInterfaceId": "eni-7tqc2xgl",
                "InstanceId": "ein-1kb08tq6",
                "AddressIp": "",
                "State": "AVAILABLE",
                "Business": "",
                "CreatedTime": "2020-04-03 20:00:05"
            },
            {
                "HaVipId": "havip-bk4275i0",
                "HaVipName": "22",
                "Vip": "10.2.0.14",
                "VpcId": "vpc-22222222",
                "SubnetId": "subnet-22222222",
                "NetworkInterfaceId": "",
                "InstanceId": "",
                "AddressIp": "",
                "Business": "",
                "State": "UNBIND",
                "CreatedTime": "2020-04-03 20:05:33"
            }
        ],
        "TotalCount": 2,
        "RequestId": "1c827bf1-837f-4302-b51a-4d538b7ad249"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.InternalOperationFailure	内部操作错误。
InvalidParameter.Coexist	参数不支持同时指定。
InvalidParameterValue.InvaildPageParam	分页参数不合法。
InvalidParameterValue.InvalidFilter	无效过滤器。
InvalidParameterValue.InvalidRegion	ecm region不合法。
InvalidParameterValue.Malformed	入参格式不合法。
InvalidParameterValue.TooLong	参数值太长。
UnauthorizedOperation.ForbiddenOperation	没有权限进行该操作。

查询HAVIP列表

本页目录：