Queries high-availability virtual IP addresses (HAVIPs) in a specified region.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeHaVips

The operation that you want to perform. Set the value toDescribeHaVips.

RegionId String Yes cn-hangzhou

The ID of the region where you want to query HAVIPs.

You can call the DescribeRegions operation to query region IDs.

PageNumber Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Maximum value: 50. Default value: 10.

Filter.N.Key String No HaVipId.havip-bp149uyvut73dpldu****

Specifies filter conditions. You can specify at most five filter conditions.Valid values ofn: 1 to 5.

You can specify multiple values for each filter condition. The logic operator among multiple values is OR. If at least one value is matched, the filter condition is met.

The logic relationship among multiple filter conditions is AND. Response is returned only when all filter conditions are met.

The following filter conditions are available:

  • VpcId: specifies the ID of the virtual private cloud (VPC).
  • VSwitchId: specifies the ID of the VSwitch.
  • Status: specifies the status of the HAVIP.
  • HaVipId: specifies the ID of the HAVIP.
  • HaVipAddress: specifies the IP address of the HAVIP.
Filter.N.Value.N RepeatList No 1

Specifies the value of the filter condition.Valid values ofn: 1 to 5.

Response parameters

Parameter Type Example Description
HaVips Array of HaVip

The details of the HAVIP.

AssociatedEipAddresses List 121.xx.xx.12

The elastic IP address (EIP) associated with the HAVIP.

AssociatedInstances List i-bp145q7glnuzdvzu21xxxx

The Elastic Compute Service (ECS) instance that is associated with the HAVIP.

ChargeType String none

The parameter is invalid. The returned value is none.

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

The time when the HAVIP was created.

Description String My HaVip

The description of the HAVIP.

HaVipId String havip-bp149uyvut73dpld****

The ID of the HAVIP.

IpAddress String 192.xx.xx.27

The private IP address of the HAVIP.

MasterInstanceId String i-bp145q7glnuzdvz****

The ID of the active instance to be associated with the HAVIP.

Name String test

The name of the HAVIP.

RegionId String cn-hangzhou

The region ID of the HAVIP.

Status String Available

The status of the HAVIP.

VSwitchId String vsw-bp1pkt1fba8e824ez****

The ID of the VSwitch to which the HAVIP belongs.

VpcId String vpc-bp1kcm36tevkpms97****

The ID of the VPC to which the HAVIP belongs.

PageNumber Integer 1

The number of the returned page.

PageSize Integer 10

The number of entries returned per page.

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

The ID of the request.

TotalCount Integer 1

The total number of entries returned.


Sample requests

&Common request parameters

Sample success responses

XML format


JSON format

    "TotalCount": 1,
    "HaVips": {
        "HaVip": [
                "Status": "InUse",
                "Description": "",
                "AssociatedEipAddresses": {
                    "associatedEipAddresse": [
                "VSwitchId": "vsw-hp3izinkr3z9xmpfm****",
                "CreateTime": "2020-08-17T07:49:31Z",
                "HaVipId": "havip-hp34cvmp99ccxi89k****",
                "Name": "",
                "AssociatedInstances": {
                    "associatedInstance": [
                "VpcId": "vpc-hp3usj8308rws2r4w****",
                "MasterInstanceId": "i-hp3i6071qw5usdnh****",
                "ChargeType": "",
                "IpAddress": "192.xx.xx.88",
                "RegionId": "cn-huhehaote"
    "PageSize": 10,
    "RequestId": "F3B026B9-7EB7-4FE2-8AA7-D7A394C24259",
    "PageNumber": 1

Error codes

HttpCode Error code Error message Description
404 InvalidFilterKey.ValueNotSupported Specified filter key is not supported: Filter.X.key The error message returned because Filter.X.key is not supported.

For a list of error codes, visit the API Error Center.