调用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 RepeatList havip-bp19o63nequs01i8d****

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

返回数据

名称 类型 示例值 描述
HaVips Array of HaVip

HaVip的详细信息。

HaVip
AssociatedEipAddresses List 121.12.XX.XX

与HaVip绑定的EIP。

AssociatedInstanceType String EcsInstance

与HaVip关联的实例类型。

AssociatedInstances List i-bp145q7glnuzdvzu21****

与HaVip绑定的ECS实例。

ChargeType String none

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

CreateTime String 2021-07-03T14:25:26Z

HaVip的创建时间。

Description String My HaVip

HaVip实例的描述。

HaVipId String havip-bp149uyvut73dpld****

HaVip实例ID。

IpAddress String 192.27.XX.XX

HaVip的私网IP地址。

MasterInstanceId String i-bp145q7glnuzdvz****

与HaVip绑定的主实例ID。

Name String test

HaVip实例的名称。

RegionId String cn-hangzhou

HaVip实例所属的地域ID。

Status String Available

HaVip实例的状态。取值:

  • Creating:创建中。
  • Available:可用。
  • Deleting:删除中。
VSwitchId String vsw-bp1pkt1fba8e824ez****

HaVip实例所属的交换机ID。

VpcId String vpc-bp1kcm36tevkpms97****

HaVip实例所属的VPC ID。

PageNumber Integer 1

当前页码。

PageSize Integer 10

每页包含的条目数。

RequestId String 33E480C5-B46F-4CA5-B6FD-D77C746E86AB

请求ID。

TotalCount Integer 1

列表条目数。

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeHaVips 
&RegionId=cn-hangzhou 
&Filter=HaVipId.havip-bp149uyvut73dplduo****
&公共请求参数

正常返回示例

XML格式

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

JSON格式

{
    "DescribeHaVipsResponse": {
        "TotalCount": 1,
        "HaVips": {
            "HaVip": {
                "Status": "Available",
                "Description": "My HaVip",
                "VpcId": "vpc-bp1kcm36tevkpms97****",
                "MasterInstanceId": "i-bp145q7glnuzdvz****",
                "ChargeType": "none",
                "CreateTime": "2018-07-03T14:25:26Z",
                "VSwitchId": "vsw-bp1pkt1fba8e824ez****",
                "IpAddress": "192.27.XX.XX",
                "RegionId": "cn-hangzhou",
                "HaVipId": "havip-bp149uyvut73dpld****",
                "AssociatedInstanceType": "EcsInstance",
                "Name": "test",
                "AssociatedInstances": {
                    "associatedInstance": "i-bp145q7glnuzdvzu21****"
                },
                "AssociatedEipAddresses": {
                    "associatedEipAddresse": "121.12.XX.XX"
                }
            }
        },
        "PageSize": 10,
        "RequestId": "33E480C5-B46F-4CA5-B6FD-D77C746E86AB",
        "PageNumber": 1
    }
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidFilterKey.ValueNotSupported Specified filter key is not supported: Filter.X.key 该过滤器的Key不支持:Filter.X.key。

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