DescribeHaVips API Overview for ENS HAVIP Retrieval - ENS

Queries high-availability virtual IP addresses (HAVIPs).

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ens:DescribeHaVips

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
NetworkId	string	No	The ID of the network.	n-57gqcdfvx6n****
VSwitchId	string	No	The ID of the vSwitch.	vsw-5****
HaVipId	string	No	The ID of the HAVIP.	havip-5p14t****
HaVipAddress	string	No	The IP address of the HAVIP.	10.5.XX.XX
EnsRegionId	string	No	The ID of the region.	cn-beijing-cmcc
Name	string	No	The name of the HAVIP.	test
Status	string	No	The status of the HAVIP. Valid values: Creating Available InUse Deleting	Available
EnsRegionIds	array	No	The IDs of edge nodes. You can specify 1 to 100 IDs.
	string	No	The ID of the edge node.	cn-chengdu-telecom-4
PageNumber	string	No	The page number.	1
PageSize	string	No	The number of entries per page.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	AAE90880-4970-4D81-A534-A6C0F3631F74
TotalCount	string	The total number of entries returned.	49
PageSize	string	The number of entries per page.	10
PageNumber	string	The page number.	1
HaVips	array<object>	Details of the HAVIPs.
	array<object>	Details of the HAVIP.
Status	string	The status of the HAVIP. Valid values: Creating Available InUse Deleting	Available
CreationTime	string	The time when the HAVIP was created.	2023-03-29T11:17:38Z
Description	string	The description of the HAVIP.	test
HaVipId	string	The ID of the HAVIP.	havip-52y28****
Name	string	The name of the HAVIP.	test
EnsRegionId	string	The ID of the region.	cn-guiyang-14
NetworkId	string	The ID of the network.	n-5wtkyrk****
VSwitchId	string	The ID of the vSwitch.	vsw-5yc8d****
IpAddress	string	The IP address of the HAVIP.	192.XX.XX.5
AssociatedEipAddresses	array<object>	The elastic IP addresses (EIPs) that are associated with the HAVIP.
	object	The EIP that is associated with the HAVIP.
EipId	string	The ID of the EIP.	eip-5p1wz****
Eip	string	The EIP.	47.XX.XX.40
AssociatedInstances	array<object>	The information about instances that are associated with the HAVIP.
	object	The information about the instance that is associated with the HAVIP.
InstanceId	string	The ID of the instance.	i-51p****
InstanceType	string	The type of the instance that is associated with the HAVIP. Valid values: EnsInstance: ENS instance NetworkInterface: elastic network interface (ENI)	EnsInstance
IpAddress	string	The private IP address of the instance that is associated with the HAVIP. Valid values:	192.XX.XX.9
Status	string	The association status of the HAVIP. Valid values: Associating InUse Unassociating	InUse
CreationTime	string	The time when the instance was created.	2023-01-05T07:09:28Z

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
400	SystemError	Interface call error, please re-match, or contact the product.	Interface call error, please re-select
400	Invalid%s	The specified parameter %s is invalid.
400	Missing%s	You must specify the parameter %s.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.