Domain name for API request: clb.tencentcloudapi.com.
This API is used to get the list of listeners by CLB ID, listener protocol, or listener port. If no filter is specified, all listeners for the CLB instance will be returned.
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: DescribeListeners. |
Version | Yes | String | Common Params. The value used for this API: 2018-03-17. |
Region | No | String | Common Params. This parameter is not required for this API. |
LoadBalancerId | Yes | String | CLB instance ID. |
ListenerIds.N | No | Array of String | Array of CLB listener IDs to query (100 IDs at most). |
Protocol | No | String | Type of the listener protocols to be queried. Values: TCP, UDP, HTTP, HTTPS, TCP_SSLand QUIC`. |
Port | No | Integer | Port of the listeners to be queried |
Parameter Name | Type | Description |
---|---|---|
Listeners | Array of Listener | Listener list |
TotalCount | Integer | Total number of listeners (with filters of port, protocol, and listener ID applied). Note: This field may return null , indicating that no valid values can be obtained. |
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://clb.tencentcloudapi.com/?Action=DescribeListeners
&LoadBalancerId=lb-aniq7ewx
&Protocol=TCP
&Port=333
&ListenerIds.0=lbl-hd9nfp6o
&<Common request parameters>
{
"Response": {
"TotalCount": 1,
"Listeners": [
{
"ListenerId": "lbl-hd9nfp6o",
"ListenerName": "12345",
"CreateTime": "2020-12-31 12:03:36",
"Protocol": "TCP",
"Port": 333,
"EndPort": 0,
"HealthCheck": {
"HealthSwitch": 1,
"TimeOut": 2,
"IntervalTime": 5,
"HealthNum": 3,
"UnHealthNum": 3,
"CheckPort": null,
"CheckType": "TCP",
"HttpCheckDomain": null,
"HttpCheckPath": null,
"HttpCheckMethod": null,
"HttpVersion": null,
"HttpCode": null,
"ContextType": null,
"SendContext": null,
"RecvContext": null,
"ExtendedCode": null,
"SourceIpType": 0
},
"Certificate": null,
"Scheduler": "WRR",
"SessionExpireTime": 0,
"SniSwitch": 0,
"Rules": null,
"TargetType": "NODE",
"TargetGroup": null,
"KeepaliveEnable": null,
"SessionType": "NORMAL",
"Toa": false,
"DeregisterTargetRst": false,
"MaxConn": 100,
"MaxCps": 100,
"IdleConnectTimeout": 0,
"AttrFlags": [
"abc"
],
"TargetGroupList": null
}
],
"RequestId": "3ddae670-4a89-4919-af6e-0d6bf195c92e"
}
}
https://clb.tencentcloudapi.com/?Action=DescribeListeners
&LoadBalancerId=lb-aniq7ewx
&<Common request parameters>
{
"Response": {
"TotalCount": 1,
"Listeners": [
{
"ListenerId": "lbl-hd9nfp6o",
"ListenerName": "12345",
"CreateTime": "2020-12-31 12:03:36",
"Protocol": "TCP",
"Port": 333,
"EndPort": 0,
"HealthCheck": {
"HealthSwitch": 1,
"TimeOut": 2,
"IntervalTime": 5,
"HealthNum": 3,
"UnHealthNum": 3,
"CheckPort": null,
"CheckType": "TCP",
"HttpCheckDomain": null,
"HttpCheckPath": null,
"HttpCheckMethod": null,
"HttpVersion": null,
"HttpCode": null,
"ContextType": null,
"SendContext": null,
"RecvContext": null,
"ExtendedCode": null,
"SourceIpType": 0
},
"Certificate": null,
"Scheduler": "WRR",
"SessionExpireTime": 0,
"SniSwitch": 0,
"Rules": null,
"TargetType": "NODE",
"TargetGroup": null,
"KeepaliveEnable": null,
"SessionType": "NORMAL",
"Toa": false,
"DeregisterTargetRst": false,
"MaxConn": 100,
"MaxCps": 100,
"IdleConnectTimeout": 0,
"AttrFlags": [
"abc"
],
"TargetGroupList": null
}
],
"RequestId": "3ddae670-4a89-4919-af6e-0d6bf195c92e"
}
}
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.LBIdNotFound | Wrong CLB instance ID. |
InvalidParameter.RegionNotFound | Invalid region. |
InvalidParameterValue | Incorrect parameter value. |
InvalidParameterValue.InvalidFilter | Incorrect Filter parameter. |
InvalidParameterValue.Length | Wrong parameter length. |
UnauthorizedOperation | Unauthorized operation. |
本页内容是否解决了您的问题?