DescribeListener_全球加速_API文档-阿里云OpenAPI开发者门户

接口说明

本接口用于查询指定监听的配置信息，包括监听的路由类型、状态、创建的时间戳、端口信息等。

流控信息

请求速率为300/60(s)。更多流控信息，请前往配额中心查看

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

ga:DescribeListener	Get	Listener acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}	无	无

请求参数

字段名称	字段详情
RegionIdstring	全球加速实例所在的地域 ID，仅取值cn-hangzhou。示例值:cn-hangzhou
ListenerIdstring	要查询的监听的 ID。示例值:lsr-bp1bpn0kn908w4nbw****参考取值来源: ListListeners CreateListener AssociateAclsWithListener DissociateAclsFromListener

返回参数

字段名称	字段详情
Descriptionstring	监听的描述信息。示例值:Listener
RequestIdstring	请求 ID。示例值:6FEA0CF3-D3B9-43E5-A304-D217037876A8
Statestring	监听的状态。展开详情示例值:active
CreateTimestring	创建监听的时间戳。单位：毫秒。示例值:1577786252000
PortRangesarray<object>	监听端口信息。
BackendPortsarray<object>	后端端口信息。
Certificatesarray<object>	SSL 证书列表。
Protocolstring	监听的网络传输协议类型。展开详情示例值:tcp
ListenerIdstring	监听 ID。示例值:lsr-bp1bpn0kn908w4nbw****
ClientAffinitystring	客户端亲和性。展开详情示例值:SOURCE_IP
Namestring	监听的名称。示例值:Listener
RelatedAclsarray<object>	监听绑定的访问控制策略组信息。
AclTypestring	访问控制类型：展开详情示例值:white
AcceleratorIdstring	全球加速实例 ID。示例值:ga-bp1odcab8tmno0hdq****
deprecatedProxyProtocolboolean	是否开启了保持客户端源 IP 功能。展开详情示例值:false
XForwardedForConfigobject	`XForward`字段配置信息。
SecurityPolicyIdstring	安全策略实例 ID。展开详情示例值:tls_cipher_policy_1_0
Typestring	监听的路由类型。展开详情示例值:Standard
ServiceIdstring	托管实例所属的服务方 ID。展开详情示例值:ALB
ServiceManagedboolean	是否为托管实例。取值：展开详情示例值:true
ServiceManagedInfosarray<object>	用户在此托管实例下可执行的动作策略列表。展开详情
IdleTimeoutinteger<int32>	连接空闲超时时间。单位：秒。示例值:900
RequestTimeoutinteger<int32>	HTTP/HTTPS 的连接请求超时时间。单位：秒。展开详情示例值:60
HttpVersionstring	HTTP 协议的最大版本，取值：展开详情示例值:http2

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	NotExist.Listener	listener %s is not exist	诊断
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.	诊断

变更历史

	变更时间	变更内容概要	操作
	2024-03-27	变更返回参数
	2023-11-06	变更返回参数
	2023-08-15	变更返回参数
	2023-04-06	新增错误码400
	2021-04-27	变更返回参数

DescribeListener_全球加速_API文档

接口说明

流控信息

授权信息

请求参数

返回参数

返回示例

错误码

变更历史

相关示例