Queries HAVIPs in a region.
Debugging
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
vpc:DescribeHaVips | get | *HaVip acs:vpc:{#regionId}:{#accountId}:havip/* |
| none |
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 page number. 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. | |
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 parameters
Examples
Sample success responses
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. |
404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | The RegionId parameter is set to an invalid value. Specify a valid value and try again. |
404 | InvalidFilterKey.ValueNotSupported | Specified filter key is not supported: Filter.X.key | Filter.X.key is not supported. |
For a list of error codes, visit the Service error codes.