【2023年10月13日】边缘计算机器部分接口鉴权升级公告
【2022年06月01日】边缘计算机器网络带宽支持按天结算公告
Domain name for API request: ecm.intl.tencentcloudapi.com.
This API is used to query the list of CLB instances.
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: DescribeLoadBalancers. |
| 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. |
| EcmRegion | No | String | Region. If this parameter is not specified, the information of all regions will be queried by default. |
| LoadBalancerIds.N | No | Array of String | CLB instance ID. |
| LoadBalancerName | No | String | CLB instance name. |
| LoadBalancerVips.N | No | Array of String | VIP address of the CLB instance. There can be multiple addresses. |
| BackendPrivateIps.N | No | Array of String | Private IP of the real server bound to the CLB. |
| Offset | No | Integer | Data offset. Default value: 0. |
| Limit | No | Integer | Number of returned CLB instances. Default value: 20. Maximum value: 100. |
| WithBackend | No | Integer | Whether the CLB instance is bound to a real server. 0: no; 1: yes; -1: query all. If this parameter is not specified, all will be queried by default. |
| VpcId | No | String | Unique VPC ID of the CLB instance, such as vpc-bhqkbhdx. |
| Filters.N | No | Array of Filter | Each request can contain up to 10 Filters and 100 Filter.Values. The detailed filters are as follows:tag-key - String - Required: no - (Filter) Filter by tag key. |
| SecurityGroup | No | String | Security group. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of eligible CLB instances. This value is independent of the Limit in the input parameter.Note: this field may return null, indicating that no valid values can be obtained. |
| LoadBalancerSet | Array of LoadBalancer | Array of returned CLB instances. 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. |
https://ecm.intl.tencentcloudapi.com/?Action=DescribeLoadBalancers
&EcmRegion=ap-hangzhou-ecm
&<Common request parameters>{
"Response": {
"RequestId": "8d42288f-3fad-473a-93e6-cab5b219af8e",
"LoadBalancerSet": [
{
"Status": 1,
"StatusTime": "2020-07-28 10:58:08",
"VpcId": "vpc-pugaiwf9",
"LoadBalancerVips": [
"101.67.8.110"
],
"VipIsp": "CUCC",
"CreateTime": "2020-07-28 10:58:06",
"LoadBalancerId": "lb-a8q643wj",
"LoadBalancerName": "test",
"LoadBalancerType": "OPEN",
"Region": "xx",
"Position": {
"Province": {
"ProvinceId": "xx",
"ProvinceName": "xx"
},
"City": {
"CityId": "xx",
"CityName": "xx"
},
"Area": {
"AreaId": "xx",
"AreaName": "xx"
},
"Country": {
"CountryName": "xx",
"CountryId": "xx"
},
"ZoneInfo": {
"ZoneName": "xx",
"Zone": "xx",
"ZoneId": 0
},
"RegionInfo": {
"Region": "xx",
"RegionId": 0,
"RegionName": "xx"
}
},
"Tags": [
{
"TagValue": "test",
"TagKey": "test"
}
],
"NetworkAttributes": {
"InternetMaxBandwidthOut": 100
}
}
],
"TotalCount": 1
}
}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 |
|---|---|
| AuthFailure.UnauthorizedOperation | Authentication failed. |
| FailedOperation.InternalOperationFailure | Internal error. |
| InvalidParameter.FormatError | The parameter format is incorrect. |
| InvalidParameter.InvalidDataFormat | The data format is incorrect. |
| InvalidParameter.RegionNotFound | The region is invalid. |
| InvalidParameterValue.InvalidFilter | The filter is invalid. |
| InvalidParameterValue.InvalidPublicParam | The common parameter is invalid. |
| InvalidParameterValue.Length | The parameter length is incorrect. |
| InvalidParameterValue.Range | The parameter value is not in the specified range. |
| UnauthorizedOperation.ForbiddenOperation | You don't have the permission to perform this operation. |
文档反馈