调用DescribeHaVips接口查询指定地域内的高可用虚拟IP（HaVip）。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
HaVip 所在的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 |
cn-hangzhou |
| PageNumber |
integer |
否 |
列表的页码。默认值：1。 |
1 |
| PageSize |
integer |
否 |
分页查询时每页的行数，最大值为 50。默认值为 10。 |
10 |
| Filter |
array<object> |
否 |
过滤条件详细信息。 |
|
|
object |
否 |
过滤条件详细信息。 |
||
| Key |
string |
否 |
过滤条件，最多可支持 5 个过滤条件。N 的取值范围为1~5。 支持的过滤条件如下：
每个过滤条件（Filter Key）可以过滤多个值，每个值之间为“或”关系，只要有其中一个值符合则视为符合参数的过滤条件。 各个过滤条件（Filter Key）之间为“与”关系，必须符合所有参数的过滤条件，才能被查询出来。 |
HaVipId |
| Value |
array |
否 |
指定的过滤条件对应的值。N 的取值范围为1~5。 |
havip-bp19o63nequs01i8d**** |
|
string |
否 |
根据过滤条件指定过滤值。一个过滤条件支持指定多个过滤值，每个过滤值之间是“或”的关系，即只要符合其中一个过滤值，则视为匹配该过滤条件。 |
Active |
|
| ResourceGroupId |
string |
否 |
HaVip 所属的资源组 ID。 |
rg-bp67acfmxazb4ph**** |
| Tags |
array<object> |
否 |
标签列表。 |
|
|
object |
否 |
标签列表。 |
||
| Key |
string |
否 |
资源的标签键。最多支持输入 20 个标签键。如需传入该值，则不能输入空字符串。 一个标签键最多支持 128 个字符，不能以 |
FinanceDept |
| Value |
string |
否 |
资源的标签值。最多支持输入 20 个标签值。如需传入该值，可以输入空字符串。 最多支持 128 个字符，不能以 |
FinanceJoshua |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
每页包含的条目数。 |
||
| PageSize |
integer |
每页包含的条目数。 |
10 |
| RequestId |
string |
请求 ID。 |
33E480C5-B46F-4CA5-B6FD-D77C746E86AB |
| PageNumber |
integer |
当前页码。 |
1 |
| TotalCount |
integer |
列表条目数。 |
1 |
| HaVips |
object |
||
| HaVip |
array<object> |
HaVip 的详细信息。 |
|
|
array<object> |
HaVip 的详细信息。 |
||
| VpcId |
string |
HaVip 所属的 VPC ID。 |
vpc-bp1kcm36tevkpms97**** |
| Status |
string |
HaVip 的状态。取值：
|
Available |
| HaVipId |
string |
HaVip 的 ID。 |
havip-bp149uyvut73dpld**** |
| AssociatedInstanceType |
string |
与 HaVip 绑定的实例类型。取值：
|
EcsInstance |
| CreateTime |
string |
HaVip 的创建时间。 |
2021-07-03T14:25:26Z |
| ChargeType |
string |
该参数为无效参数，返回值为空。 |
none |
| RegionId |
string |
HaVip 所属的地域 ID。 |
cn-hangzhou |
| VSwitchId |
string |
HaVip 所属的交换机 ID。 |
vsw-bp1pkt1fba8e824ez**** |
| IpAddress |
string |
HaVip 的私网 IP 地址。 |
192.168.24.5 |
| Description |
string |
HaVip 的描述。 |
My HaVip |
| MasterInstanceId |
string |
与 HaVip 绑定的主实例 ID。 |
i-bp145q7glnuzdvz**** |
| Name |
string |
HaVip 的名称。 |
test |
| AssociatedEipAddresses |
object |
||
| associatedEipAddresse |
array |
与 HaVip 绑定的 EIP 列表。 |
|
|
string |
与 HaVip 绑定的 EIP。 |
121.12.XX.XX |
|
| AssociatedInstances |
object |
||
| associatedInstance |
array |
与 HaVip 绑定的实例信息。 |
|
|
string |
与 HaVip 绑定的实例 ID。 |
i-bp145q7glnuzdvzu21**** |
|
| ResourceGroupId |
string |
HaVip 所属的资源组 ID。 |
rg-bp67acfmxazb4ph**** |
| Tags |
object |
||
| Tag |
array<object> |
标签列表。 |
|
|
object |
标签列表。 |
||
| Key |
string |
标签键。 |
FinanceDept |
| Value |
string |
标签值。 |
FinanceJoshua |
示例
正常返回示例
JSON格式
{
"PageSize": 10,
"RequestId": "33E480C5-B46F-4CA5-B6FD-D77C746E86AB",
"PageNumber": 1,
"TotalCount": 1,
"HaVips": {
"HaVip": [
{
"VpcId": "vpc-bp1kcm36tevkpms97****",
"Status": "Available",
"HaVipId": "havip-bp149uyvut73dpld****",
"AssociatedInstanceType": "EcsInstance",
"CreateTime": "2021-07-03T14:25:26Z",
"ChargeType": "none",
"RegionId": "cn-hangzhou",
"VSwitchId": "vsw-bp1pkt1fba8e824ez****",
"IpAddress": "192.168.24.5",
"Description": "My HaVip",
"MasterInstanceId": "i-bp145q7glnuzdvz****",
"Name": "test",
"AssociatedEipAddresses": {
"associatedEipAddresse": [
"121.12.XX.XX"
]
},
"AssociatedInstances": {
"associatedInstance": [
"i-bp145q7glnuzdvzu21****"
]
},
"ResourceGroupId": "rg-bp67acfmxazb4ph****",
"Tags": {
"Tag": [
{
"Key": "FinanceDept",
"Value": "FinanceJoshua"
}
]
}
}
]
}
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | Forbidden.HaVip | No permissions to perform operations on HAVIPs. Please apply for privilege--vpc_privilege_allow_buy_havip_instance. | 操作HaVip没有权限，请到配额中心申请权限。 |
| 400 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | |
| 400 | InvalidFilterKey.ValueNotSupported | Specified filter key is not supported: Filter.X.key |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。