Queries HaVips in a region.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The region ID of the HaVip. You can call the DescribeRegions operation to query the most recent region list. |
cn-hangzhou |
| PageNumber |
integer |
No |
The number of the returned page. Default value: 1. |
1 |
| PageSize |
integer |
No |
The number of entries per page. Maximum value: 50. Default value: 10. |
10 |
| Filter |
array<object> |
No |
The details of the filter condition. |
|
|
object |
No |
|||
| Key |
string |
No |
The filter keys. You can specify at most five filter keys. Valid values of N: 1 to 5. The following filter keys are supported:
You can specify multiple values for each filter key. The logical operator among multiple values is OR. If one value is matched, the filter key is matched. The logical operator among multiple filter keys is AND. HaVips can be queried only if all filter keys are matched. |
HaVipId |
| Value |
array |
No |
The value of the filter key. Valid values of N: 1 to 5. |
havip-bp19o63nequs01i8d**** |
|
string |
No |
The filter values for filter keys. You can specify multiple filter values for one key. The logical operator between filter values is OR. If one filter value is matched, the filter key is matched. |
Active |
|
| ResourceGroupId |
string |
No |
The ID of the resource group to which the HaVip belongs. |
rg-bp67acfmxazb4ph**** |
| Tags |
array<object> |
No |
The tag list. |
|
|
object |
No |
|||
| Key |
string |
No |
The key of tag N to add to the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 128 characters in length. It cannot start with |
FinanceDept |
| Value |
string |
No |
The value of tag N to add to the resource. You can specify at most 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot contain |
FinanceJoshua |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The number of entries per page. |
||
| PageSize |
integer |
The number of entries per page. |
10 |
| RequestId |
string |
The request ID. |
33E480C5-B46F-4CA5-B6FD-D77C746E86AB |
| PageNumber |
integer |
The page number. |
1 |
| TotalCount |
integer |
The number of entries returned. |
1 |
| HaVips |
object |
||
| HaVip |
array<object> |
The details about the HaVip. |
|
|
array<object> |
|||
| VpcId |
string |
The ID of the VPC to which the HaVip belongs. |
vpc-bp1kcm36tevkpms97**** |
| Status |
string |
The status of the HaVip. Valid values:
|
Available |
| HaVipId |
string |
The ID of the HaVip. |
havip-bp149uyvut73dpld**** |
| AssociatedInstanceType |
string |
The type of the instance with which the HaVip is associated. Valid values:
|
EcsInstance |
| CreateTime |
string |
The time when the HaVip was created. |
2021-07-03T14:25:26Z |
| ChargeType |
string |
The parameter is invalid. No value is returned. |
none |
| RegionId |
string |
The ID of the region to which the HaVip belongs. |
cn-hangzhou |
| VSwitchId |
string |
The ID of the vSwitch to which the HaVip belongs. |
vsw-bp1pkt1fba8e824ez**** |
| IpAddress |
string |
The private IP address of the HaVip. |
192.168.24.5 |
| Description |
string |
The description of the HaVip. |
My HaVip |
| MasterInstanceId |
string |
The ID of the active instance that is associated with the HaVip. |
i-bp145q7glnuzdvz**** |
| Name |
string |
The name of the HaVip. |
test |
| AssociatedEipAddresses |
object |
||
| associatedEipAddresse |
array |
The list of EIPs associated with the HaVip. |
|
|
string |
The EIP that is associated with the HaVip. |
121.12.XX.XX |
|
| AssociatedInstances |
object |
||
| associatedInstance |
array |
The information about the instance associated with the HaVip. |
|
|
string |
The ID of the instance with which the HaVip is associated. |
i-bp145q7glnuzdvzu21**** |
|
| ResourceGroupId |
string |
The ID of the resource group to which the HaVip belongs. |
rg-bp67acfmxazb4ph**** |
| Tags |
object |
||
| Tag |
array<object> |
The tag list. |
|
|
object |
|||
| Key |
string |
The key of tag N added to the resource. |
FinanceDept |
| Value |
string |
The value of tag N added to the resource. |
FinanceJoshua |
Examples
Success response
JSON format
{
"PageSize": 10,
"RequestId": "33E480C5-B46F-4CA5-B6FD-D77C746E86AB",
"PageNumber": 1,
"TotalCount": 1,
"HaVips": {
"HaVip": [
{
"VpcId": "vpc-bp1kcm36tevkpms97****",
"Status": "Available",
"HaVipId": "havip-bp149uyvut73dpld****",
"AssociatedInstanceType": "EcsInstance",
"CreateTime": "2021-07-03T14:25:26Z",
"ChargeType": "none",
"RegionId": "cn-hangzhou",
"VSwitchId": "vsw-bp1pkt1fba8e824ez****",
"IpAddress": "192.168.24.5",
"Description": "My HaVip",
"MasterInstanceId": "i-bp145q7glnuzdvz****",
"Name": "test",
"AssociatedEipAddresses": {
"associatedEipAddresse": [
"121.12.XX.XX"
]
},
"AssociatedInstances": {
"associatedInstance": [
"i-bp145q7glnuzdvzu21****"
]
},
"ResourceGroupId": "rg-bp67acfmxazb4ph****",
"Tags": {
"Tag": [
{
"Key": "FinanceDept",
"Value": "FinanceJoshua"
}
]
}
}
]
}
}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. | The error message returned because you do not have the permissions to manage the HAVIP. Go to the Quota Center page to acquire the permissions. |
| 400 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | |
| 400 | 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.