Release Notes
Announcements
Domain name for API request: vpc.intl.tencentcloudapi.com.
This API (DescribeHaVips) is used to query the list of highly available virtual IPs (HAVIP).
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeHaVips. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| HaVipIds.N | No | Array of String | The unique ID of the HAVIP, such as havip-9o233uri. |
| Filters.N | No | Array of Filter | Filter condition. HaVipIds and Filters cannot be specified at the same time.li>havip-id - String - The unique ID of the HAVIP, such as havip-9o233uri. |
| Offset | No | Integer | Offset |
| Limit | No | Integer | The returned quantity |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | The number of objects meeting the condition. |
| HaVipSet | Array of HaVip | HAVIP object array. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
https://vpc.intl.tencentcloudapi.com/?Action=DescribeHaVips
&HaVipIds.0=havip-bk4275i0
&HaVipIds.1=havip-2kce8v4q
&<Common request parameters>{
"Response": {
"HaVipSet": [
{
"HaVipId": "havip-2kce8v4q",
"HaVipName": "tadfafd",
"Vip": "10.3.3.15",
"VpcId": "vpc-o31qeah3",
"SubnetId": "subnet-8qywqc4y",
"NetworkInterfaceId": "",
"InstanceId": "",
"AddressIp": "",
"Business": "",
"State": "UNBOUND",
"CreatedTime": "2018-04-03 20:00:05"
},
{
"HaVipId": "havip-bk4275i0",
"HaVipName": "22",
"Vip": "10.2.0.14",
"VpcId": "vpc-2mcdauzl",
"SubnetId": "subnet-mnmm19fg",
"NetworkInterfaceId": "",
"InstanceId": "",
"AddressIp": "",
"Business": "",
"State": "UNBOUND",
"CreatedTime": "2018-04-03 20:05:33"
}
],
"TotalCount": 2,
"RequestId": "1c827bf1-837f-4302-b51a-4d538b7ad249"
}
}https://vpc.intl.tencentcloudapi.com/?Action=DescribeHaVips
&Filters.0.Name=havip-name
&Filters.0.Values.0=test
&Filters.1.Name=vpc-id
&Filters.1.Values.0=vpc-6v2ht8q5
&<Common request parameters>{
"Response": {
"HaVipSet": [
{
"HaVipId": "havip-iyy1ykky",
"HaVipName": "test modify",
"Vip": "10.4.6.17",
"VpcId": "vpc-6v2ht8q5",
"SubnetId": "subnet-qq51iwr4",
"NetworkInterfaceId": "",
"InstanceId": "",
"AddressIp": "",
"Business": "",
"State": "UNBOUND",
"CreatedTime": "2018-10-09 18:08:16"
}
],
"TotalCount": 1,
"RequestId": "659cd6a3-a75a-473c-8280-af27c33da8bd"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError.ModuleError | Internal module error |
| InvalidParameter.Coexist | The parameters cannot be specified at the same time. |
| InvalidParameter.FilterInvalidKey | The specified filter condition does not exist. |
| InvalidParameterValue.LimitExceeded | The parameter value exceeds the limit. |
| InvalidParameterValue.Malformed | Invalid input parameter format. |
| InvalidParameterValue.Range | The parameter value is not in the specified range. |
| InvalidParameterValue.TooLong | Invalid parameter value. The parameter value is too long. |
フィードバック