DescribeHaVips - Elastic Compute Service - Alibaba Cloud Documentation Center

DescribeHaVips

Note

This API has been deprecated. We recommend migrating to Vpc(2016-04-28) - DescribeHaVips for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

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

vpc:DescribeHaVips

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region.
PageNumber	integer	No	The page number. Default value: 1.
PageSize	integer	No	The number of entries per page. Maximum value: 50. Default value: 10.
Filter	array<object>	Yes	The query filters. You can specify 1 to 20 filters.
	object	No	A filter consisting of a key and one or more values.
Key	string	No	The filter key. Valid values: `HaVipId`: The ID of the high-availability virtual IP (HAVIP). `HaVipName`: The name of the HAVIP. `VpcId`: The ID of the VPC to which the HAVIP belongs. `VSwitchId`: The ID of the vSwitch to which the HAVIP belongs. `IpAddress`: The IP address of the HAVIP. `AssociatedInstanceType`: The type of instance associated with the HAVIP. The value must be `EcsInstance`. `AssociatedInstanceId`: The ID of the instance associated with the HAVIP.
Value	array	No	A list of 1 to 20 values.
	string	No	A filter value.

Response elements

Element	Type	Description	Example
	object	The data returned.
PageSize	integer	The number of entries per page.
RequestId	string	The request ID.
PageNumber	integer	The page number.
TotalCount	integer	The total number of entries returned.
HaVips	object	Details of the HaVips.
HaVip	array<object>	The array of HaVip objects.
	array<object>
Status	string	The status of the HaVip. Valid values: `Creating`, `Available`, `Associating`, `Unassociating`, `Deleting`, and `Deleted`.
VpcId	string	The ID of the VPC to which the HaVip belongs.
VSwitchId	string	The ID of the VSwitch to which the HaVip belongs.
IpAddress	string	The private IP address of the HaVip.
Description	string	The description of the HaVip.
HaVipId	string	The ID of the HaVip.
CreateTime	string	The time when the HaVip was created. The time is in UTC and is formatted as `YYYY-MM-DDThh:mm:ssZ`.
MasterInstanceId	string	The ID of the master ECS instance associated with the HaVip.
RegionId	string	The ID of the region to which the HaVip belongs.
AssociatedEipAddresses	object	The EIPs associated with the HaVip.
associatedEipAddresse	array	An array of associated EIPs.
	string	An associated EIP.
AssociatedInstances	object	The ECS instances associated with the HaVip.
associatedInstance	array	An array of associated ECS instance IDs.
	string	An associated ECS instance ID.

Examples

Success response

JSON format

{
  "PageSize": 0,
  "RequestId": "",
  "PageNumber": 0,
  "TotalCount": 0,
  "HaVips": {
    "HaVip": [
      {
        "Status": "",
        "VpcId": "",
        "VSwitchId": "",
        "IpAddress": "",
        "Description": "",
        "HaVipId": "",
        "CreateTime": "",
        "MasterInstanceId": "",
        "RegionId": "",
        "AssociatedEipAddresses": {
          "associatedEipAddresse": [
            ""
          ]
        },
        "AssociatedInstances": {
          "associatedInstance": [
            ""
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Forbidden.HaVip	No permissions to perform operations on HAVIPs. Please apply for privilege--vpc_privilege_allow_buy_havip_instance.	You do not have the permissions to manage the HAVIP. Go to the Quota Center to apply for the permissions.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	Region information error
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.