【2023年10月13日】边缘计算机器部分接口鉴权升级公告
【2022年06月01日】边缘计算机器网络带宽支持按天结算公告
Domain name for API request: ecm.intl.tencentcloudapi.com.
This API is used to query the list of HAVIPs.
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: 2019-07-19. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| HaVipIds.N | No | Array of String | Array of unique HAVIP IDs, such as havip-9o233uri. |
| Filters.N | No | Array of Filter | Filter. HaVipIds and Filters cannot be specified at the same time.havip-id - String - Unique HAVIP ID, such as havip-9o233uri.havip-name - String - HAVIP name. vpc-id - String - VPC ID of the HAVIP. subnet-id - String - Subnet ID of the HAVIP. |
| Offset | No | Integer | Offset. Default value: 0. |
| Limit | No | Integer | Number of returned results. Default value: 20. Maximum value: 100. |
| EcmRegion | No | String | ECM region. If this parameter is left empty, it will indicate all regions. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of eligible objects. |
| HaVipSet | Array of HaVip | Array of HAVIP objects. Note: this field may return null, indicating that no valid values can be obtained. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: ecm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeHaVips
<Common request parameters>
{
"HaVipIds": [
"havip-bk4275i0",
"havip-2kce8v4q"
]
}{
"Response": {
"HaVipSet": [
{
"HaVipId": "havip-2kce8v4q",
"HaVipName": "tadfafd",
"Vip": "10.3.3.15",
"VpcId": "vpc-11111111",
"SubnetId": "subnet-11111111",
"NetworkInterfaceId": "eni-7tqc2xgl",
"InstanceId": "ein-1kb08tq6",
"AddressIp": "",
"State": "AVAILABLE",
"Business": "",
"CreatedTime": "2020-04-03 20:00:05"
},
{
"HaVipId": "havip-bk4275i0",
"HaVipName": "22",
"Vip": "10.2.0.14",
"VpcId": "vpc-22222222",
"SubnetId": "subnet-22222222",
"NetworkInterfaceId": "",
"InstanceId": "",
"AddressIp": "",
"Business": "",
"State": "UNBIND",
"CreatedTime": "2020-04-03 20:05:33"
}
],
"TotalCount": 2,
"RequestId": "1c827bf1-837f-4302-b51a-4d538b7ad249"
}
}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 |
|---|---|
| FailedOperation.InternalOperationFailure | Internal error. |
| InvalidParameter.Coexist | The parameters cannot be specified at the same time. |
| InvalidParameterValue.InvaildPageParam | The pagination parameter is invalid. |
| InvalidParameterValue.InvalidFilter | The filter is invalid. |
| InvalidParameterValue.InvalidRegion | The ECM region is invalid. |
| InvalidParameterValue.Malformed | The input parameter format is invalid. |
| InvalidParameterValue.TooLong | The parameter value is too long. |
| UnauthorizedOperation.ForbiddenOperation | You don't have the permission to perform this operation. |
文档反馈