调用 DescribeHaVips 接口，查询满足指定条件的高可用虚拟IP（HAVIP）。

使用说明

传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的HAVIP，若没有符合条件的HAVIP，则返回空值。

若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有HAVIP。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action String 必选示例值：DescribeHaVips

接口名称。当前 API 的名称为DescribeHaVips。

Version String 必选示例值：2020-04-01

接口版本。当前 API 的版本为 2020-04-01。

VpcId String 可选示例值：vpc-bp1s5fnvk4gn2tws03****

HAVIP所属私有网络的ID。

您可以调用 DescribeVpcs 接口，查询VPC的ID。

SubnetId String 可选示例值：subnet-bp1s5fnvk4gn2tws03****

HAVIP所属子网的ID。

您可以调用 DescribeSubnets 接口，查询子网的ID。

IpAddress String 可选示例值：192.XX.XX.10

HAVIP的IP地址。

HaVipIds.N String 可选示例值：havip-2zeo05qre24nhrqpy****

HAVIP的ID。

参数 - N：表示HAVIP的ID序号，单次调用数量上限100个。

多个HAVIP的ID之间用&分隔。

HaVipName String 可选示例值：havip-test-name

HAVIP的名称。

Status String 可选示例值：Available

HAVIP的状态。

Available：可用

Creating：创建中

InUse：使用中

Deleting：删除中

ProjectName String 可选示例值：Project-1

HAVIP的项目名称。

TagFilters.N.Key String 可选示例值：k1

标签的标签键。

参数 - N：表示标签键的序号，取值范围：1～10。

多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的HAVIP。

不允许重复。

TagFilters.N.Values.N String 可选示例值：v1

标签的标签值。

第一个N：表示标签键的序号，取值范围：1～10。

第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的HAVIP。

多个标签值之间用&分隔。

说明

若传入该参数，则必须先传入TagFilters.N.Key。

传入空字符串时，表示查询标签值为空的HAVIP。

PageNumber Integer 可选示例值：1

列表的页码。默认值为1。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

PageSize Integer 可选示例值：20

分页查询时每页的行数。最大值为100，默认值为20。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

NextToken String 可选示例值：caeba0bbb2be03f84eb48b699f0a****

分页查询凭证，用于标记分页的位置。

不填则从头开始查询。

传入之前调用本API返回的NextToken，则从该次API调用标记分页的位置往后开始查询。

MaxResults Integer 可选示例值：50

查询的数量，默认为 10，最大为100。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

RequestId String 示例值：2021062415303301022514515207C4****

请求ID。

TotalCount Integer 示例值：2

符合条件的HAVIP总数。

说明

本参数即将下线，使用NextToken和MaxResults分页查询时，此参数无意义。

PageNumber Integer 示例值：1

当前页码。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

PageSize Integer 示例值：10

当前分页的行数。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

NextToken String 示例值：caeba0bbb2be03f84eb48b699f0a****

本次API调用返回的查询凭证，标记分页的位置，用于下一次查询。返回为空表示没有下一页。

HaVips Object[] 示例值：-

HAVIP的详细信息。

CreatedAt String 示例值：2021-08-05T21:46:55+08:00

创建HAVIP的时间。

UpdatedAt String 示例值：2021-08-05T21:48:55+08:00

更新HAVIP的时间。

AccountId String 示例值：200000****

HAVIP所属账号的ID。

Status String 示例值：Available

HAVIP的状态。

Description String 示例值：test havip

HAVIP的描述信息。

HaVipId String 示例值：havip-273whz6qg3k7fap8tw****

HAVIP的ID。

HaVipName String 示例值：havip-test-name

HAVIP的名称。

MasterInstanceId String 示例值：i-sad5kl1we****

与HAVIP绑定的主实例的ID。

VpcId String 示例值：vpc-274dzjk74o0e87fap8u****

HAVIP所属私有网络的ID。

SubnetId String 示例值：subnet-274dzk7vi0o3k7fap8sp****

HAVIP所属子网的ID。

AssociatedInstanceType String 示例值：EcsInstance

绑定HAVIP的实例类型。

EcsInstance：云服务器实例

NetworkInterface：弹性网卡

AssociatedInstanceIds String[] 示例值：i-sad5kl1we****

绑定HAVIP的实例ID列表。

AssociatedEipId String 示例值：eip-2ziwb7ujxscd*****

HAVIP绑定的公网IP的ID。

AssociatedEipAddress String 示例值：132.XX.XX.45

HAVIP绑定的公网IP的IP地址。

ProjectName String 示例值：Project-1

HAVIP的项目名称。

Tags Object[] 示例值：-

高可用虚拟IP的标签信息。

Key String 示例值：k1

标签的标签键。

Value String 示例值：v1

标签的标签值。

请求示例

返回示例

错误码

状态码	错误码	错误信息	说明
400	DryRunOperation	Exception raised to indicate a successfully authorized action when the DryRun flag is set to true.	该请求设置为DryRun操作，操作授权已获得许可，但未被实际执行。
400	InvalidMaxResults.Malformed	The specified parameter MaxResults is malformed.	查询数量不合法。
400	InvalidNextToken.Malformed	The specified parameter NextToken is invalid.	查询 NextToken 不合法。
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	InvalidTagFilter.Disorder	The specified index order of tag filter is malformed.	指定标签过滤项的索引顺序参数格式不合法。
400	InvalidTagFilterKey.Malformed	The specified parameter tag filter key is invalid.	过滤标签键不合法。
400	InvalidTagFilterValue.Malformed	The specified parameter tag filter value is invalid.	过滤标签值不合法。
400	LimitExceeded.HaVipId	You've reached the limit on the number of HaVip IDs that you can describe.	已达到可查询的高可用虚拟IP ID数量上限。
400	LimitExceeded.TagFilterKey	You've reached the limit on the number of tag keys that you can filter.	已达到单次可指定过滤标签键数量的上限。
400	LimitExceeded.TagFilterValue	You've reached the limit on the number of tag values that you can filter.	已达到单次可指定过滤标签值数量的上限。
404	InvalidSubnet.NotFound	The specified subnet does not exist.	指定的子网不存在。
404	InvalidVpc.NotFound	The specified VPC does not exist.	指定的VPC不存在。