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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeHaVips

系统规定参数。取值：DescribeHaVips。
RegionId String 是 cn-hangzhou

HaVip实例所在的地域ID。

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

列表的页码。默认值：1。
PageSize Integer 否 10

分页查询时每页的行数，最大值为50。默认值为10。
Filter.N.Key String 否 HaVipId

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

支持的过滤条件如下：

  • VpcId：专有网络ID。
  • VSwitchId：交换机ID。
  • Status：HaVip实例状态。
  • HaVipId：HaVip实例ID。
  • HaVipAddress：HaVip实例的IP地址。

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

各个过滤条件（Filter Key）之间为“与”关系，必须符合所有参数的过滤条件，才能被查询出来。
Filter.N.Value.N String 否 Active

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

高可用虚拟IP所属的资源组ID。
Tags.N.Key String 否 FinanceDept

标签键。最多支持输入20个标签键。一旦传入该值，则不允许为空字符串。

一个标签键最多支持64个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以aliyun和acs:开头，不能包含http://或者https://。
Tags.N.Value String 否 FinanceJoshua

标签值。最多支持输入20个标签值。一旦传入该值，可以为空字符串。

一个标签值最多支持128个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以aliyun和acs:开头，不能包含http://或者https://。

返回数据

名称 类型 示例值 描述
PageSize Integer 10

每页包含的条目数。
RequestId String 33E480C5-B46F-4CA5-B6FD-D77C746E86AB

请求ID。
PageNumber Integer 1

当前页码。
TotalCount Integer 1

列表条目数。
HaVips Array of HaVip

HaVip的详细信息。
HaVip
VpcId String vpc-bp1kcm36tevkpms97****

HaVip实例所属的VPC ID。
Status String Available

HaVip实例的状态。取值：

  • Creating：创建中。
  • Available：可用。
  • Deleting：删除中。
HaVipId String havip-bp149uyvut73dpld****

HaVip实例ID。
AssociatedInstanceType String EcsInstance

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

  • EcsInstance：云服务器ECS实例。
  • NetworkInterface：弹性网卡实例。
CreateTime String 2021-07-03T14:25:26Z

HaVip的创建时间。
ChargeType String none

该参数为无效参数，返回值为空。
RegionId String cn-hangzhou

HaVip实例所属的地域ID。
VSwitchId String vsw-bp1pkt1fba8e824ez****

HaVip实例所属的交换机ID。
IpAddress String 192.168.24.5

HaVip的私网IP地址。
Description String My HaVip

HaVip实例的描述。
MasterInstanceId String i-bp145q7glnuzdvz****

与HaVip绑定的主实例ID。
Name String test

HaVip实例的名称。
AssociatedEipAddresses Array of String 121.12.XX.XX

与HaVip绑定的EIP。
AssociatedInstances Array of String i-bp145q7glnuzdvzu21****

与HaVip绑定的实例ID。
ResourceGroupId String rg-bp67acfmxazb4ph****

高可用虚拟IP所属的资源组ID。
Tags Array of Tag

标签列表。
Tag
Key String FinanceDept

标签键。
Value String FinanceJoshua

标签值。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeHaVips
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=10
&Filter=[{"Key":"HaVipId","Value":["Active"]}]
&ResourceGroupId=rg-bp67acfmxazb4ph****
&Tags=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeHaVipsResponse>
    <PageSize>10</PageSize>
    <RequestId>33E480C5-B46F-4CA5-B6FD-D77C746E86AB</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <HaVips>
        <VpcId>vpc-bp1kcm36tevkpms97****</VpcId>
        <Status>Available</Status>
        <HaVipId>havip-bp149uyvut73dpld****</HaVipId>
        <AssociatedInstanceType>EcsInstance</AssociatedInstanceType>
        <CreateTime>2021-07-03T14:25:26Z</CreateTime>
        <ChargeType>none</ChargeType>
        <RegionId>cn-hangzhou</RegionId>
        <VSwitchId>vsw-bp1pkt1fba8e824ez****</VSwitchId>
        <IpAddress>192.168.24.5</IpAddress>
        <Description>My HaVip</Description>
        <MasterInstanceId>i-bp145q7glnuzdvz****</MasterInstanceId>
        <Name>test</Name>
        <AssociatedEipAddresses>121.12.XX.XX</AssociatedEipAddresses>
        <AssociatedInstances>i-bp145q7glnuzdvzu21****</AssociatedInstances>
        <ResourceGroupId>rg-bp67acfmxazb4ph****</ResourceGroupId>
        <Tags>
            <Key>FinanceDept</Key>
            <Value>FinanceJoshua</Value>
        </Tags>
    </HaVips>
</DescribeHaVipsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 10,
  "RequestId" : "33E480C5-B46F-4CA5-B6FD-D77C746E86AB",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "HaVips" : [ {
    "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" : [ "121.12.XX.XX" ],
    "AssociatedInstances" : [ "i-bp145q7glnuzdvzu21****" ],
    "ResourceGroupId" : "rg-bp67acfmxazb4ph****",
    "Tags" : [ {
      "Key" : "FinanceDept",
      "Value" : "FinanceJoshua"
    } ]
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 Forbidden.HaVip No permissions to perform operations on HAVIPs. Please apply for privilege--vpc_privilege_allow_buy_havip_instance. 操作HaVip没有权限，请到配额中心申请权限。
404 InvalidFilterKey.ValueNotSupported Specified filter key is not supported: Filter.X.key 该过滤器的Key不支持：Filter.X.key。

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