调用DescribeHaVips接口查询指定地域内的高可用虚拟IP（HaVip）。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| vpc:DescribeHaVips | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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。 | |
| string | 否 | 根据过滤条件指定过滤值。一个过滤条件支持指定多个过滤值，每个过滤值之间是“或”的关系，即只要符合其中一个过滤值，则视为匹配该过滤条件。 | Active | |
| ResourceGroupId | string | 否 | 高可用虚拟 IP 所属的资源组 ID。 | rg-bp67acfmxazb4ph**** |
| Tags | array<object> | 否 | 标签列表。 | |
| object | 否 | 标签列表。 | ||
| Key | string | 否 | 资源的标签键。最多支持输入 20 个标签键。如需传入该值，则不能输入空字符串。 一个标签键最多支持 128 个字符，不能以 | FinanceDept |
| Value | string | 否 | 资源的标签值。最多支持输入 20 个标签值。如需传入该值，可以输入空字符串。 最多支持 128 个字符，不能以 | 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没有权限，请到配额中心申请权限。 |
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | 指定的RegionId不存在。请检查该参数是否正确。 |
| 404 | InvalidFilterKey.ValueNotSupported | Specified filter key is not supported: Filter.X.key | 该过滤器的Key不支持：Filter.X.key。 |
访问错误中心查看更多错误码。