All Products
Search
Document Center

:DescribeHaVips

Last Updated:Dec 25, 2024

Queries high-availability virtual IP addresses (HAVIPs).

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ens:DescribeHaVipslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
NetworkIdstringNo

The ID of the network.

n-57gqcdfvx6n****
VSwitchIdstringNo

The ID of the vSwitch.

vsw-5****
HaVipIdstringNo

The ID of the HAVIP.

havip-5p14t****
HaVipAddressstringNo

The IP address of the HAVIP.

10.5.XX.XX
EnsRegionIdstringNo

The ID of the region.

cn-beijing-cmcc
NamestringNo

The name of the HAVIP.

test
StatusstringNo

The status of the HAVIP. Valid values:

  • Creating
  • Available
  • InUse
  • Deleting
Available
PageNumberstringNo

The page number.

1
PageSizestringNo

The number of entries per page.

10

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

AAE90880-4970-4D81-A534-A6C0F3631F74
TotalCountstring

The total number of entries returned.

49
PageSizestring

The number of entries per page.

10
PageNumberstring

The page number.

1
HaVipsarray<object>

Details of the HAVIPs.

HaVipobject

Details of the HAVIP.

Statusstring

The status of the HAVIP. Valid values:

  • Creating
  • Available
  • InUse
  • Deleting
Available
CreationTimestring

The time when the HAVIP was created.

2023-03-29T11:17:38Z
Descriptionstring

The description of the HAVIP.

test
HaVipIdstring

The ID of the HAVIP.

havip-52y28****
Namestring

The name of the HAVIP.

test
EnsRegionIdstring

The ID of the region.

cn-guiyang-14
NetworkIdstring

The ID of the network.

n-5wtkyrk****
VSwitchIdstring

The ID of the vSwitch.

vsw-5yc8d****
IpAddressstring

The IP address of the HAVIP.

192.XX.XX.5
AssociatedEipAddressesarray<object>

The elastic IP addresses (EIPs) that are associated with the HAVIP.

eipobject

The EIP that is associated with the HAVIP.

EipIdstring

The ID of the EIP.

eip-5p1wz****
Eipstring

The EIP.

47.XX.XX.40
AssociatedInstancesarray<object>

The information about instances that are associated with the HAVIP.

relationobject

The information about the instance that is associated with the HAVIP.

InstanceIdstring

The ID of the instance.

i-51p****
InstanceTypestring

The type of the instance that is associated with the HAVIP. Valid values:

  • EnsInstance: ENS instance
  • NetworkInterface: elastic network interface (ENI)
EnsInstance
IpAddressstring

The private IP address of the instance that is associated with the HAVIP. Valid values:

192.XX.XX.9
Statusstring

The association status of the HAVIP. Valid values:

  • Associating
  • InUse
  • Unassociating
InUse
CreationTimestring

The time when the instance was created.

2023-01-05T07:09:28Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "AAE90880-4970-4D81-A534-A6C0F3631F74",
  "TotalCount": "49",
  "PageSize": "10",
  "PageNumber": "1",
  "HaVips": [
    {
      "Status": "Available",
      "CreationTime": "2023-03-29T11:17:38Z",
      "Description": "test",
      "HaVipId": "havip-52y28****",
      "Name": "test",
      "EnsRegionId": "cn-guiyang-14",
      "NetworkId": "n-5wtkyrk****",
      "VSwitchId": "vsw-5yc8d****",
      "IpAddress": "192.XX.XX.5\n",
      "AssociatedEipAddresses": [
        {
          "EipId": "eip-5p1wz****",
          "Eip": "47.XX.XX.40"
        }
      ],
      "AssociatedInstances": [
        {
          "InstanceId": "i-51p****",
          "InstanceType": "EnsInstance",
          "IpAddress": "192.XX.XX.9",
          "Status": "InUse",
          "CreationTime": "2023-01-05T07:09:28Z"
        }
      ]
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400SystemErrorInterface call error, please re-match, or contact the product.Interface call error, please re-select
400Invalid%sThe specified parameter %s is invalid.-
400Missing%sYou must specify the parameter %s.-
400NoPermissionPermission denied.-
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

For a list of error codes, visit the Service error codes.