文档

DescribeHaVips - 查询地域内的高可用虚拟IP(HaVip)

更新时间:

调用DescribeHaVips接口查询指定地域内的高可用虚拟IP(HaVip)。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:DescribeHaVipsList
  • HaVip
    acs:vpc:{#regionId}:{#accountId}:havip/*

请求参数

名称类型必填描述示例值
RegionIdstring

HaVip 实例所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
PageNumberinteger

列表的页码。默认值:1

1
PageSizeinteger

分页查询时每页的行数,最大值为 50。默认值为 10

10
Filterarray<object>

过滤条件详细信息。

object

过滤条件详细信息。

Keystring

过滤条件,最多可支持 5 个过滤条件。N 的取值范围为1~5。 支持的过滤条件如下:

  • VpcId:专有网络 ID。

  • VSwitchId:交换机 ID。

  • Status:HaVip 实例状态。

  • HaVipId:HaVip 实例 ID。

  • HaVipAddress:HaVip 实例的 IP 地址。

每个过滤条件(Filter Key)可以过滤多个值,每个值之间为“或”关系,只要有其中一个值符合则视为符合参数的过滤条件。

各个过滤条件(Filter Key)之间为“与”关系,必须符合所有参数的过滤条件,才能被查询出来。

HaVipId
Valuearray

指定的过滤条件对应的值。N 的取值范围为1~5

string

根据过滤条件指定过滤值。一个过滤条件支持指定多个过滤值,每个过滤值之间是“或”的关系,即只要符合其中一个过滤值,则视为匹配该过滤条件。

Active
ResourceGroupIdstring

高可用虚拟 IP 所属的资源组 ID。

rg-bp67acfmxazb4ph****
Tagsarray<object>

标签列表。

object

标签列表。

Keystring

资源的标签键。最多支持输入 20 个标签键。如需传入该值,则不能输入空字符串。

一个标签键最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept
Valuestring

资源的标签值。最多支持输入 20 个标签值。如需传入该值,可以输入空字符串。

最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceJoshua

返回参数

名称类型描述示例值
object

每页包含的条目数。

PageSizeinteger

每页包含的条目数。

10
RequestIdstring

请求 ID。

33E480C5-B46F-4CA5-B6FD-D77C746E86AB
PageNumberinteger

当前页码。

1
TotalCountinteger

列表条目数。

1
HaVipsarray<object>

HaVip 的详细信息。

object

HaVip 的详细信息。

VpcIdstring

HaVip 实例所属的 VPC ID。

vpc-bp1kcm36tevkpms97****
Statusstring

HaVip 实例的状态。取值:

  • Creating:创建中。

  • Available:可用。

  • Deleting:删除中。

Available
HaVipIdstring

HaVip 实例 ID。

havip-bp149uyvut73dpld****
AssociatedInstanceTypestring

与 HaVip 绑定的实例类型。取值:

  • EcsInstance:云服务器 ECS 实例。
  • NetworkInterface:弹性网卡实例。
EcsInstance
CreateTimestring

HaVip 的创建时间。

2021-07-03T14:25:26Z
ChargeTypestring

该参数为无效参数,返回值为空。

none
RegionIdstring

HaVip 实例所属的地域 ID。

cn-hangzhou
VSwitchIdstring

HaVip 实例所属的交换机 ID。

vsw-bp1pkt1fba8e824ez****
IpAddressstring

HaVip 的私网 IP 地址。

192.168.24.5
Descriptionstring

HaVip 实例的描述。

My HaVip
MasterInstanceIdstring

与 HaVip 绑定的主实例 ID。

i-bp145q7glnuzdvz****
Namestring

HaVip 实例的名称。

test
AssociatedEipAddressesarray

与 HaVip 绑定的 EIP 列表。

string

与 HaVip 绑定的 EIP。

121.12.XX.XX
AssociatedInstancesarray

与 HaVip 绑定的实例信息。

string

与 HaVip 绑定的实例 ID。

i-bp145q7glnuzdvzu21****
ResourceGroupIdstring

高可用虚拟 IP 所属的资源组 ID。

rg-bp67acfmxazb4ph****
Tagsarray<object>

标签列表。

object

标签列表。

Keystring

标签键。

FinanceDept
Valuestring

标签值。

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错误码错误信息描述
400Forbidden.HaVipNo permissions to perform operations on HAVIPs. Please apply for privilege--vpc_privilege_allow_buy_havip_instance.操作HaVip没有权限,请到配额中心申请权限。
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.指定的RegionId不存在。请检查该参数是否正确。
404InvalidFilterKey.ValueNotSupportedSpecified filter key is not supported: Filter.X.key该过滤器的Key不支持:Filter.X.key。

访问错误中心查看更多错误码。