调用ListListeners接口查询指定全球实例下的监听列表。
接口说明
本接口用于查询全球加速实例下的监听列表,包括各监听的路由类型、状态、创建的时间戳、端口信息等。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
ga:ListListeners |
list |
*Listener
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
RegionId |
string |
是 |
全球加速实例所在的地域 ID,仅取值cn-hangzhou。 |
cn-hangzhou |
PageNumber |
integer |
否 |
列表的页码,默认值为 1。 |
1 |
PageSize |
integer |
否 |
分页查询时每页的条目数,最大值为 50,默认值为 10。 |
10 |
AcceleratorId |
string |
是 |
全球加速实例 ID。 |
ga-bp1odcab8tmno0hdq**** |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
返回信息列表。 |
||
TotalCount |
integer |
列表条目数。 |
1 |
Listeners |
array<object> |
监听信息。 |
|
object |
监听信息。 |
||
Certificates |
array<object> |
SSL 证书信息。 |
|
object |
SSL 证书信息。 |
||
Type |
string |
证书类型。 目前,仅支持返回 Server(服务端证书)。 |
Server |
Id |
string |
SSL 证书 ID。 |
44983xxxx-cn-hangzhou |
BackendPorts |
array<object> |
后端服务器端口信息。 |
|
object |
后端服务器端口信息。 |
||
FromPort |
string |
后端服务器的起始端口。 |
80 |
ToPort |
string |
后端服务器的结束端口。 |
80 |
ListenerId |
string |
监听 ID。 |
lsr-bp1bpn0kn908w4nbw**** |
Description |
string |
监听的描述信息。 |
Listener |
State |
string |
监听的状态。
|
active |
ClientAffinity |
string |
客户端亲和性。
|
SOURCE_IP |
Protocol |
string |
监听的网络传输协议类型。
|
TCP |
CreateTime |
integer |
创建监听的时间戳。单位:毫秒。 |
1577786252000 |
PortRanges |
array<object> |
监听端口信息。 |
|
object |
监听端口信息。 |
||
FromPort |
integer |
用来接收请求并向终端节点进行转发的起始监听端口。 |
20 |
ToPort |
integer |
用来接收请求并向终端节点进行转发的结束监听端口。 |
20 |
Name |
string |
监听的名称。 |
Listener |
ProxyProtocol
deprecated
|
boolean |
是否开启了保持客户端源 IP 功能。
|
true |
AcceleratorId |
string |
全球加速实例 ID。 |
ga-bp1odcab8tmno0hdq**** |
XForwardedForConfig |
object |
|
|
XForwardedForGaIdEnabled |
boolean |
是否通过
说明
仅 HTTP 和 HTTPS 监听支持此参数。 |
false |
XRealIpEnabled |
boolean |
是否通过
说明
仅 HTTP 和 HTTPS 监听支持此参数。 |
false |
XForwardedForGaApEnabled |
boolean |
是否通过
说明
仅 HTTP 和 HTTPS 监听支持此参数。 |
false |
XForwardedForProtoEnabled |
boolean |
是否通过
说明
仅 HTTP 和 HTTPS 监听支持此参数。 |
false |
XForwardedForPortEnabled |
boolean |
是否通过
说明
仅 HTTP 和 HTTPS 监听支持此参数。 |
false |
SecurityPolicyId |
string |
安全策略实例 ID。
说明
仅 HTTPS 监听支持此参数。 |
tls_cipher_policy_1_0 |
Type |
string |
监听的路由类型。
|
Standard |
ServiceId |
string |
托管实例所属的服务方 ID。 说明
仅在 ServiceManaged 参数为 True 时有效。 |
ALB |
ServiceManaged |
boolean |
是否为托管实例。取值:
|
true |
ServiceManagedInfos |
array<object> |
用户在此托管实例下可执行的动作策略列表。 说明
|
|
object |
用户在此托管实例下可执行的动作策略列表。 |
||
Action |
string |
托管策略动作名称,取值:
|
Update |
ChildType |
string |
子资源类型,取值:
说明
仅在 Action 参数为 CreateChild 时有效 |
Listener |
IsManaged |
boolean |
托管策略动作是否被托管,取值:
|
false |
IdleTimeout |
integer |
连接空闲超时时间。单位:秒。 |
900 |
RequestTimeout |
integer |
HTTP/HTTPS 的连接请求超时时间。单位:秒。 说明
仅对 Protocol(网络传输协议类型)为 HTTP 或 HTTPS 的监听有效。如果在超时时间内后端服务器一直没有响应,全球加速将放弃等待,并给客户端返回 HTTP 504 错误码。 |
60 |
HttpVersion |
string |
HTTP 协议的最大版本,取值:
说明
仅 HTTPS 监听支持此参数。 |
http2 |
PageSize |
integer |
分页查询时每页的条目数。 |
10 |
RequestId |
string |
请求 ID。 |
6FEA0CF3-D3B9-43E5-A304-D217037876A8 |
PageNumber |
integer |
列表的页码。 |
1 |
示例
正常返回示例
JSON
格式
{
"TotalCount": 1,
"Listeners": [
{
"Certificates": [
{
"Type": "Server",
"Id": "44983xxxx-cn-hangzhou"
}
],
"BackendPorts": [
{
"FromPort": "80",
"ToPort": "80"
}
],
"ListenerId": "lsr-bp1bpn0kn908w4nbw****",
"Description": "Listener",
"State": "active",
"ClientAffinity": "SOURCE_IP",
"Protocol": "TCP",
"CreateTime": 1577786252000,
"PortRanges": [
{
"FromPort": 20,
"ToPort": 20
}
],
"Name": "Listener",
"ProxyProtocol": true,
"AcceleratorId": "ga-bp1odcab8tmno0hdq****",
"XForwardedForConfig": {
"XForwardedForGaIdEnabled": false,
"XRealIpEnabled": false,
"XForwardedForGaApEnabled": false,
"XForwardedForProtoEnabled": false,
"XForwardedForPortEnabled": false
},
"SecurityPolicyId": "tls_cipher_policy_1_0",
"Type": "Standard",
"ServiceId": "ALB",
"ServiceManaged": true,
"ServiceManagedInfos": [
{
"Action": "Update",
"ChildType": "Listener",
"IsManaged": false
}
],
"IdleTimeout": 900,
"RequestTimeout": 60,
"HttpVersion": "http2"
}
],
"PageSize": 10,
"RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8",
"PageNumber": 1
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
500 | UnknownError | An error occurred while processing your request. Please try again. If the error persists, please submit a ticket. | 处理请求时出现错误,请稍后重试。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。