产品动态
产品公告
Domain name for API request: clb.intl.tencentcloudapi.com.
This API is used to query the list of CLB instances in a region.
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: 2018-03-17. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| LoadBalancerIds.N | No | Array of String | CLB instance IDs. There can be up to 20 IDs. |
| LoadBalancerType | No | String | CLB instance network type: OPEN: public network; INTERNAL: private network. |
| Forward | No | Integer | CLB instance type. 1: generic CLB instance; 0: classic CLB instance |
| LoadBalancerName | No | String | Specifies the name of the clb instance. fuzzy query is supported. |
| Domain | No | String | Tencent cloud assigns a domain name to the cloud load balancer instance. fuzzy query is supported. |
| LoadBalancerVips.N | No | Array of String | VIP address of a CLB instance (there can be multiple addresses) |
| BackendPublicIps.N | No | Array of String | Public IPs of the backend services bound with the load balancer. Only the public IPs of CVMs are supported now. |
| BackendPrivateIps.N | No | Array of String | Private IPs of the backend services bound with the load balancer. Only the private IPs of CVMs are supported now. |
| Offset | No | Integer | Data offset. Default value: 0. |
| Limit | No | Integer | Number of returned CLB instances. Default value: 20. Maximum value: 100. |
| OrderBy | No | String | Sorting parameter. supports the following fields:. - LoadBalancerName - CreateTime - Domain - LoadBalancerType Defaults to CreateTime. |
| OrderType | No | Integer | 1 for descending, 0 for ascending, defaults to 1, sorted by creation time in descending order. |
| SearchKey | No | String | Specifies the fuzzy search field for fuzzy matching the name, domain name, VIP address, or ID of a cloud load balancer instance. |
| ProjectId | No | Integer | Project ID of the cloud load balancer instance. you can call the DescribeProject api to obtain the ID. defaults to all projects if not passed. |
| WithRs | No | Integer | Whether a CLB instance is bound to a real server. 0: no; 1: yes; -1: query all. |
| VpcId | No | String | Specifies the unique vpc ID of the load balancing instance, such as vpc-bhqkbhdx. you can call the DescribeVpcs api to obtain it. Searches for cloud load balancer of basic network type. allows input '0'. |
| SecurityGroup | No | String | Security group ID, such as sg-m1cc****, can be obtained through the API DescribeSecurityGroups. |
| MasterZone | No | String | Primary availability zone ID, such as 100001 (corresponding to Guangzhou Zone 1). You can obtain the list of availability zones through DescribeZones. |
| Filters.N | No | Array of Filter | Each request can have up to 10 Filters and 100 Filter.Values. Detailed filter conditions:TRAFFIC_POSTPAID_BY_HOUR |
| AdditionalFields.N | No | Array of String | Specifies the expanded fields to return. not specified, expanded fields do not return by default. supported expanded fields are as follows:. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of CLB instances that meet the filter criteria. This value is independent of the Limit in the input parameter. |
| LoadBalancerSet | Array of LoadBalancer | Array of returned CLB instances. |
| 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. |
This example shows you how to query CLB instances bound to the real server with the private IP address 172.26.0.11.
POST / HTTP/1.1
Host: clb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLoadBalancers
<Common request parameters>
{
"LoadBalancerIds": [
"lb-rbw5****"
]
}{
"Response": {
"TotalCount": 1,
"LoadBalancerSet": [
{
"LoadBalancerId": "lb-rbw5****",
"LoadBalancerName": "test_LB_****",
"Forward": 1,
"Domain": "",
"LoadBalancerDomain": "",
"LoadBalancerVips": [
"119.***.***.51"
],
"AddressIPv6": null,
"AddressIPVersion": "ipv4",
"IPv6Mode": null,
"LoadBalancerType": "OPEN",
"Status": 1,
"CreateTime": "2023-12-27 15:53:46",
"StatusTime": "2024-01-22 19:58:03",
"ProjectId": 0,
"OpenBgp": 0,
"Snat": false,
"Isolation": 0,
"Log": "",
"AnycastZone": "",
"VpcId": "vpc-1y****83",
"NumericalVpcId": 1111113,
"TargetRegionInfo": {
"Region": "ap-guangzhou",
"VpcId": "vpc-1y****83",
"NumericalVpcId": 1111113
},
"SubnetId": "",
"SecureGroups": [],
"Tags": [
{
"TagKey": "key-****",
"TagValue": "value-****"
}
],
"MasterZone": {
"ZoneId": 100003,
"Zone": "ap-guangzhou-3",
"ZoneName": "Guangzhou Zone 3",
"ZoneRegion": "ap-guangzhou",
"LocalZone": false,
"EdgeZone": false
},
"BackupZoneSet": null,
"IsolatedTime": null,
"ExpireTime": "2024-01-27 15:53:46",
"ChargeType": "POSTPAID_BY_HOUR",
"NetworkAttributes": {
"InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
"InternetMaxBandwidthOut": 5,
"BandwidthpkgSubType": "BGP"
},
"PrepaidAttributes": null,
"ExtraInfo": null,
"LogSetId": "",
"LogTopicId": "",
"LoadBalancerPassToTarget": false,
"IsDDos": false,
"ConfigId": "",
"ExclusiveCluster": {
"L4Clusters": null,
"L7Clusters": null,
"ClassicalCluster": null
},
"SnatPro": false,
"SnatIps": [],
"IsBlock": false,
"IsBlockTime": "",
"SlaType": "",
"ClusterTag": null,
"LocalBgp": false,
"MixIpTarget": false,
"Zones": null,
"NfvInfo": "",
"HealthLogSetId": "",
"HealthLogTopicId": "",
"ClusterIds": null,
"AttributeFlags": [
"SharedLimitFlag"
],
"VipIsp": "BGP",
"Egress": ""
}
],
"RequestId": "b0e9e810-01cc-4c12-8bd2-ca0a2ab1b976"
}
}POST / HTTP/1.1
Host: clb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLoadBalancers
<Common request parameters>
{
"ProjectId": "0",
"LoadBalancerType": "OPEN",
"Filters": [
{
"Values": [
"test_tag_value2",
"test_tag_value1"
],
"Name": "tag:test_tag_key"
}
],
"LoadBalancerName": "test_LB"
}{
"Response": {
"TotalCount": 1,
"LoadBalancerSet": [
{
"LoadBalancerId": "lb-rbw5****",
"LoadBalancerName": "test_LB_****",
"Forward": 1,
"Domain": "",
"LoadBalancerDomain": "",
"LoadBalancerVips": [
"119.***.***.51"
],
"AddressIPv6": null,
"AddressIPVersion": "ipv4",
"IPv6Mode": null,
"LoadBalancerType": "OPEN",
"Status": 1,
"CreateTime": "2023-12-27 15:53:46",
"StatusTime": "2024-01-22 19:58:03",
"ProjectId": 0,
"OpenBgp": 0,
"Snat": false,
"Isolation": 0,
"Log": "",
"AnycastZone": "",
"VpcId": "vpc-1y****83",
"NumericalVpcId": 1111113,
"TargetRegionInfo": {
"Region": "ap-guangzhou",
"VpcId": "vpc-1y****83",
"NumericalVpcId": 1111113
},
"SubnetId": "",
"SecureGroups": [],
"Tags": [
{
"TagKey": "key-****",
"TagValue": "value-****"
}
],
"MasterZone": {
"ZoneId": 100003,
"Zone": "ap-guangzhou-3",
"ZoneName": "Guangzhou Zone 3",
"ZoneRegion": "ap-guangzhou",
"LocalZone": false,
"EdgeZone": false
},
"BackupZoneSet": null,
"IsolatedTime": null,
"ExpireTime": "2024-01-27 15:53:46",
"ChargeType": "POSTPAID_BY_HOUR",
"NetworkAttributes": {
"InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
"InternetMaxBandwidthOut": 5,
"BandwidthpkgSubType": "BGP"
},
"PrepaidAttributes": null,
"ExtraInfo": null,
"LogSetId": "",
"LogTopicId": "",
"LoadBalancerPassToTarget": false,
"IsDDos": false,
"ConfigId": "",
"ExclusiveCluster": {
"L4Clusters": null,
"L7Clusters": null,
"ClassicalCluster": null
},
"SnatPro": false,
"SnatIps": [],
"IsBlock": false,
"IsBlockTime": "",
"SlaType": "",
"ClusterTag": null,
"LocalBgp": false,
"MixIpTarget": false,
"Zones": null,
"NfvInfo": "",
"HealthLogSetId": "",
"HealthLogTopicId": "",
"ClusterIds": null,
"AttributeFlags": [
"SharedLimitFlag"
],
"VipIsp": "BGP",
"Egress": ""
}
],
"RequestId": "b0e9e810-01cc-4c12-8bd2-ca0a2ab1b976"
}
}This example shows you how to query CLB instances bound to the real server with the private IP address 172.26.0.11.
POST / HTTP/1.1
Host: clb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLoadBalancers
<Common request parameters>
{
"BackendPrivateIps": [
"172.26.0.11"
],
"WithRs": "1"
}{
"Response": {
"TotalCount": 1,
"LoadBalancerSet": [
{
"LoadBalancerId": "lb-9vpm****",
"LoadBalancerName": "lb-test-****-1227",
"Forward": 1,
"Domain": "",
"LoadBalancerDomain": "",
"LoadBalancerVips": [
"119.***.***.51"
],
"AddressIPv6": null,
"AddressIPVersion": "ipv4",
"IPv6Mode": null,
"LoadBalancerType": "OPEN",
"Status": 1,
"CreateTime": "2023-12-27 15:53:46",
"StatusTime": "2024-01-22 19:58:03",
"ProjectId": 0,
"OpenBgp": 0,
"Snat": false,
"Isolation": 0,
"Log": "",
"AnycastZone": "",
"VpcId": "vpc-1y****83",
"NumericalVpcId": 1111113,
"TargetRegionInfo": {
"Region": "ap-guangzhou",
"VpcId": "vpc-1y****83",
"NumericalVpcId": 1111113
},
"SubnetId": "",
"SecureGroups": [],
"Tags": [
{
"TagKey": "key-****",
"TagValue": "value-****"
}
],
"MasterZone": {
"ZoneId": 100003,
"Zone": "ap-guangzhou-3",
"ZoneName": "Guangzhou Zone 3",
"ZoneRegion": "ap-guangzhou",
"LocalZone": false,
"EdgeZone": false
},
"BackupZoneSet": null,
"IsolatedTime": null,
"ExpireTime": "2024-01-27 15:53:46",
"ChargeType": "POSTPAID_BY_HOUR",
"NetworkAttributes": {
"InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
"InternetMaxBandwidthOut": 5,
"BandwidthpkgSubType": "BGP"
},
"PrepaidAttributes": null,
"ExtraInfo": null,
"LogSetId": "",
"LogTopicId": "",
"LoadBalancerPassToTarget": false,
"IsDDos": false,
"ConfigId": "",
"ExclusiveCluster": {
"L4Clusters": null,
"L7Clusters": null,
"ClassicalCluster": null
},
"SnatPro": false,
"SnatIps": [],
"IsBlock": false,
"IsBlockTime": "",
"SlaType": "",
"ClusterTag": null,
"LocalBgp": false,
"MixIpTarget": false,
"Zones": null,
"NfvInfo": "",
"HealthLogSetId": "",
"HealthLogTopicId": "",
"ClusterIds": null,
"AttributeFlags": [
"SharedLimitFlag"
],
"VipIsp": "BGP",
"Egress": ""
}
],
"RequestId": "b0e9e810-01cc-4c12-8bd2-ca0a2ab1b976"
}
}POST / HTTP/1.1
Host: clb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLoadBalancers
<Common request parameters>
{
"SearchKey": "test_LB"
}{
"Response": {
"TotalCount": 1,
"LoadBalancerSet": [
{
"LoadBalancerId": "lb-9vpm****",
"LoadBalancerName": "test_LB_****",
"Forward": 1,
"Domain": "",
"LoadBalancerDomain": "",
"LoadBalancerVips": [
"119.***.***.51"
],
"AddressIPv6": null,
"AddressIPVersion": "ipv4",
"IPv6Mode": null,
"LoadBalancerType": "OPEN",
"Status": 1,
"CreateTime": "2023-12-27 15:53:46",
"StatusTime": "2024-01-22 19:58:03",
"ProjectId": 0,
"OpenBgp": 0,
"Snat": false,
"Isolation": 0,
"Log": "",
"AnycastZone": "",
"VpcId": "vpc-1y****83",
"NumericalVpcId": 1111113,
"TargetRegionInfo": {
"Region": "ap-guangzhou",
"VpcId": "vpc-1y****83",
"NumericalVpcId": 1111113
},
"SubnetId": "",
"SecureGroups": [],
"Tags": [
{
"TagKey": "key-****",
"TagValue": "value-****"
}
],
"MasterZone": {
"ZoneId": 100003,
"Zone": "ap-guangzhou-3",
"ZoneName": "Guangzhou Zone 3"
"ZoneRegion": "ap-guangzhou",
"LocalZone": false,
"EdgeZone": false
},
"BackupZoneSet": null,
"IsolatedTime": null,
"ExpireTime": "2024-01-27 15:53:46",
"ChargeType": "POSTPAID_BY_HOUR",
"NetworkAttributes": {
"InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
"InternetMaxBandwidthOut": 5,
"BandwidthpkgSubType": "BGP"
},
"PrepaidAttributes": null,
"ExtraInfo": null,
"LogSetId": "",
"LogTopicId": "",
"LoadBalancerPassToTarget": false,
"IsDDos": false,
"ConfigId": "",
"ExclusiveCluster": {
"L4Clusters": null,
"L7Clusters": null,
"ClassicalCluster": null
},
"SnatPro": false,
"SnatIps": [],
"IsBlock": false,
"IsBlockTime": "",
"SlaType": "",
"ClusterTag": null,
"LocalBgp": false,
"MixIpTarget": false,
"Zones": null,
"NfvInfo": "",
"HealthLogSetId": "",
"HealthLogTopicId": "",
"ClusterIds": null,
"AttributeFlags": [
"SharedLimitFlag"
],
"VipIsp": "BGP",
"Egress": ""
}
],
"RequestId": "b0e9e810-01cc-4c12-8bd2-ca0a2ab1b976"
}
}POST / HTTP/1.1
Host: clb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLoadBalancers
<Common request parameters>
{
"ProjectId": "0",
"LoadBalancerType": "OPEN",
"LoadBalancerVips": [
"119.***.***.51"
],
"LoadBalancerName": "test_LB"
}{
"Response": {
"TotalCount": 1,
"LoadBalancerSet": [
{
"LoadBalancerId": "lb-rbw5****",
"LoadBalancerName": "test_LB_****",
"Forward": 1,
"Domain": "",
"LoadBalancerDomain": "",
"LoadBalancerVips": [
"119.***.***.51"
],
"AddressIPv6": null,
"AddressIPVersion": "ipv4",
"IPv6Mode": null,
"LoadBalancerType": "OPEN",
"Status": 1,
"CreateTime": "2023-12-27 15:53:46",
"StatusTime": "2024-01-22 19:58:03",
"ProjectId": 0,
"OpenBgp": 0,
"Snat": false,
"Isolation": 0,
"Log": "",
"AnycastZone": "",
"VpcId": "vpc-1y****83",
"NumericalVpcId": 1111113,
"TargetRegionInfo": {
"Region": "ap-guangzhou",
"VpcId": "vpc-1y****83",
"NumericalVpcId": 1111113
},
"SubnetId": "",
"SecureGroups": [],
"Tags": [
{
"TagKey": "key-****",
"TagValue": "value-****"
}
],
"MasterZone": {
"ZoneId": 100003,
"Zone": "ap-guangzhou-3",
"ZoneName": "Guangzhou Zone 3",
"ZoneRegion": "ap-guangzhou",
"LocalZone": false,
"EdgeZone": false
},
"BackupZoneSet": null,
"IsolatedTime": null,
"ExpireTime": "2024-01-27 15:53:46",
"ChargeType": "POSTPAID_BY_HOUR",
"NetworkAttributes": {
"InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
"InternetMaxBandwidthOut": 5,
"BandwidthpkgSubType": "BGP"
},
"PrepaidAttributes": null,
"ExtraInfo": null,
"LogSetId": "",
"LogTopicId": "",
"LoadBalancerPassToTarget": false,
"IsDDos": false,
"ConfigId": "",
"ExclusiveCluster": {
"L4Clusters": null,
"L7Clusters": null,
"ClassicalCluster": null
},
"SnatPro": false,
"SnatIps": [],
"IsBlock": false,
"IsBlockTime": "",
"SlaType": "",
"ClusterTag": null,
"LocalBgp": false,
"MixIpTarget": false,
"Zones": null,
"NfvInfo": "",
"HealthLogSetId": "",
"HealthLogTopicId": "",
"ClusterIds": null,
"AttributeFlags": [
"SharedLimitFlag"
],
"VipIsp": "BGP",
"Egress": ""
}
],
"RequestId": "b0e9e810-01cc-4c12-8bd2-ca0a2ab1b976"
}
}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 | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameter.FormatError | Wrong parameter format. |
| InvalidParameter.RegionNotFound | Invalid region. |
| InvalidParameterValue | Incorrect parameter value. |
| InvalidParameterValue.InvalidFilter | Incorrect Filter parameter. |
| InvalidParameterValue.Length | Wrong parameter length. |
| InvalidParameterValue.Range | Wrong parameter value range. |
| UnauthorizedOperation | Unauthorized operation. |
| UnsupportedOperation | Unsupported operation. |
文档反馈