Domain name for API request: ga2.intl.tencentcloudapi.com.
This API is used to query listeners.
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: 2025-01-15. |
| Region | No | String | Common Params. This parameter is not required. |
| GlobalAcceleratorId | Yes | String | Global acceleration instance ID. |
| Offset | No | Integer | Offset. Default value: 0. |
| Limit | No | Integer | Number of returns. Default value: 20. Maximum value: 100. |
| Filters.N | No | Array of Filter | Filter criteria. listener-id - String - (Filter criteria) Listener instance ID. |
| Parameter Name | Type | Description |
|---|---|---|
| ListenerSet | Array of ListenerSet | Eligible listener instance. |
| TotalCount | Integer | Number of instances that meet the criteria. |
| 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. |
POST / HTTP/1.1
Host: ga2.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeListeners
<Common request parameters>
{
"GlobalAcceleratorId": "ga-80bzejka"
}{
"Response": {
"ListenerSet": [
{
"GlobalAcceleratorId": "ga-reu65tl8",
"ListenerId": "lsr-cu9t0glx",
"Name": "diozhou_tcp_test_8888",
"Description": "",
"Protocol": "TCP",
"PortRanges": {
"FromPort": 8888,
"ToPort": 8888
},
"XForwardedForRealIp": false,
"ClientAffinity": "Close",
"ClientAffinityTime": 0,
"RequestTimeout": 60,
"CertificationType": "UNIDIRECTIONAL",
"ServerCertificates": [],
"ClientCaCertificates": [],
"CipherPolicyId": "",
"HttpVersion": "HTTP/1.1",
"CreateTime": "2025-04-04 14:11:42",
"ListenerType": "Standard",
"Status": "ACTIVE",
"EndpointGroupCounts": 1
}
],
"RequestId": "7ecf173c-1cd3-46a9-afe0-5c18fbd04202",
"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 |
|---|---|
| InvalidParameterValue | Parameter value error. |
文档反馈