调用DescribeListener查询监听_全球加速(GA)-阿里云帮助中心

调用DescribeListener接口查询指定监听的配置信息。

接口说明

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

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ga:DescribeListener	get	Listener acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	全球加速实例所在的地域 ID，仅取值cn-hangzhou。	cn-hangzhou
ListenerId	string	是	要查询的监听的 ID。	lsr-bp1bpn0kn908w4nbw****

返回参数

名称	类型	描述	示例值
	object	返回信息列表。
Description	string	监听的描述信息。	Listener
RequestId	string	请求 ID。	6FEA0CF3-D3B9-43E5-A304-D217037876A8
State	string	监听的状态。 configuring：配置中。 init：初始化。 updating：更新中。 deleting：删除中。	active
CreateTime	string	创建监听的时间戳。单位：毫秒。	1577786252000
PortRanges	array<object>	监听端口信息。
	object	监听端口信息。
FromPort	integer	用来接收请求并向终端节点进行转发的起始监听端口。	20
ToPort	integer	用来接收请求并向终端节点进行转发的结束监听端口。	20
BackendPorts	array<object>	后端端口信息。
	object	后端端口范围。
FromPort	string	后端服务器接收请求的起始端口。当您的监听协议为 HTTPS，且监听的端口和后端服务器提供服务的端口一致时才会返回该项。	80
ToPort	string	后端服务器接收请求的结束端口。	80
Certificates	array<object>	SSL 证书列表。
	object	SSL 证书列表。
Type	string	证书类型。目前，仅支持返回 Server（服务端证书）。	Server
Id	string	SSL 证书 ID。	449****-cn-hangzhou
Protocol	string	监听的网络传输协议类型。 tcp：TCP 协议。 udp：UDP 协议。 http：HTTP 协议。 https：HTTPS 协议。	tcp
ListenerId	string	监听 ID。	lsr-bp1bpn0kn908w4nbw****
ClientAffinity	string	客户端亲和性。返回为 NONE 时：不保持客户端亲和性，即不能确保来自同一客户端的连接请求始终定向到同一终端节点。返回为SOURCE_IP时，保持客户端亲和性。即客户端访问有状态的应用程序时，可以将来自同一客户端的所有请求都定向到同一终端节点，而不考虑源端口和协议。	SOURCE_IP
Name	string	监听的名称。	Listener
RelatedAcls	array<object>	监听绑定的访问控制策略组信息。
	object	监听绑定的访问控制策略组信息。
AclId	string	监听绑定的访问策略组 ID。	123
Status	string	是否开启了访问控制功能。 on：已开启。 off：未开启。	off
AclType	string	访问控制类型： white：仅转发来自所选访问控制策略组中设置的 IP 地址或地址段的请求，白名单适用于应用只允许特定 IP 访问的场景。设置白名单存在一定业务风险。一旦设置白名单，就只有白名单中的 IP 可以访问全球加速监听。如果开启了白名单访问，但访问策略组中没有添加任何 IP，则全球加速监听不会转发请求。 black：来自所选访问控制策略组中设置的 IP 地址或地址段的所有请求都不会转发，黑名单适用于应用只限制某些特定 IP 访问的场景。如果开启了黑名单访问，但访问策略组中没有添加任何 IP，则全球加速监听会转发全部请求。当 Status 参数的值为 on 时，返回该项。	white
AcceleratorId	string	全球加速实例 ID。	ga-bp1odcab8tmno0hdq****
ProxyProtocol	boolean	是否开启了保持客户端源 IP 功能。 true：开启了保持客户端源 IP 功能。开启后，支持后端服务查看客户端的原始 IP 地址。 false：未开启保持客户端源 IP 功能。	false
XForwardedForConfig	object	`XForward`字段配置信息。
XForwardedForGaIdEnabled	boolean	是否通过`GA-ID`头字段获取全球加速实例 ID。 true：是。 false：否。说明仅 HTTP 和 HTTPS 监听支持此参数。	false
XForwardedForGaApEnabled	boolean	是否通过`GA-AP`字段获取加速地域信息。 true：是。 false：否。说明仅 HTTP 和 HTTPS 监听支持此参数。	false
XForwardedForProtoEnabled	boolean	是否通过`GA-X-Forward-Proto`字段获取全球加速实例的监听协议。 true：是。 false：否。说明仅 HTTP 和 HTTPS 监听支持此参数。	false
XForwardedForPortEnabled	boolean	是否通过`GA-X-Forward-Port`字段获取全球加速实例的监听端口。 true：是。 false：否。说明仅 HTTP 和 HTTPS 监听支持此参数。	false
XRealIpEnabled	boolean	是否通过`X-Real-IP`字段获取真实的客户端 IP。 true：是。 false：否。说明仅 HTTP 和 HTTPS 监听支持此参数。	false
SecurityPolicyId	string	安全策略实例 ID。 tls_cipher_policy_1_0 支持的 TLS 版本：TLSv1.0、TLSv1.1 和 TLSv1.2。支持的加密算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA 和 DES-CBC3-SHA。 tls_cipher_policy_1_1 支持的 TLS 版本： TLSv1.1 和 TLSv1.2。支持的加密算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA 和 DES-CBC3-SHA。 tls_cipher_policy_1_2 支持的 TLS 版本：TLSv1.2。支持的加密算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA 和 DES-CBC3-SHA。 tls_cipher_policy_1_2_strict 支持的 TLS 版本：TLSv1.2。支持的加密算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-RSA-AES128-SHA 和 ECDHE-RSA-AES256-SHA。 tls_cipher_policy_1_2_strict_with_1_3 支持的 TLS 版本：TLSv1.2 及 TLSv1.3。支持的加密算法套件：TLS_AES_128_GCM_SHA256、TLS_AES_256_GCM_SHA384、TLS_CHACHA20_POLY1305_SHA256、TLS_AES_128_CCM_SHA256、TLS_AES_128_CCM_8_SHA256、ECDHE-ECDSA-AES128-GCM-SHA256、ECDHE-ECDSA-AES256-GCM-SHA384、ECDHE-ECDSA-AES128-SHA256、ECDHE-ECDSA-AES256-SHA384、ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-ECDSA-AES128-SHA、ECDHE-ECDSA-AES256-SHA、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA。说明仅 HTTPS 监听支持此参数。	tls_cipher_policy_1_0
Type	string	监听的路由类型。 Standard：智能路由类型。 CustomRouting：自定义路由类型。	Standard
ServiceId	string	托管实例所属的服务方 ID。说明仅在 ServiceManaged 参数为 True 时有效。	ALB
ServiceManaged	boolean	是否为托管实例。取值： true：是托管实例。 false：不是托管实例。	true
ServiceManagedInfos	array<object>	用户在此托管实例下可执行的动作策略列表。说明仅在 ServiceManaged 参数为 True 时有效。当实例处于托管状态时，用户对实例的操作会受到限制，某些操作行为会被禁止。
	object	用户在此托管实例下可执行的动作策略列表。
Action	string	托管策略动作名称，取值： Create：创建实例。 Update：更新当前实例。 Delete：删除当前实例。 Associate：引用/被引用当前实例。 UserUnmanaged：用户解托管实例。 CreateChild：在当前实例下创建子资源。	Update
ChildType	string	子资源类型，取值： Listener：监听资源。 IpSet：加速地域资源。 EndpointGroup：终端节点组资源。 ForwardingRule：转发策略资源。 Endpoint：终端节点资源。 EndpointGroupDestination：自定义路由监听下的终端节点组协议映射资源。 EndpointPolicy：自定义路由监听下的终端节点通行策略资源。说明仅在 Action 参数为 CreateChild 时有效。	Listener
IsManaged	boolean	托管策略动作是否被托管，取值： true：托管策略动作被托管，用户无权在托管实例下执行 Action 指定的操作。 false：托管策略动作未被托管，用户可在托管实例下执行 Action 指定的操作。	false
IdleTimeout	integer	连接空闲超时时间。单位：秒。	900
RequestTimeout	integer	HTTP/HTTPS 的连接请求超时时间。单位：秒。说明仅对 Protocol（网络传输协议类型）为 HTTP 或 HTTPS 的监听有效。如果在超时时间内后端服务器一直没有响应，全球加速将放弃等待，并给客户端返回 HTTP 504 错误码。	60
HttpVersion	string	HTTP 协议的最大版本，取值： http3：HTTP/3。 http2：HTTP/2。 http1.1：HTTP/1.1。说明仅 HTTPS 监听支持此参数。	http2

示例

正常返回示例

JSON格式

{
  "Description": "Listener",
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t",
  "State": "active",
  "CreateTime": "1577786252000",
  "PortRanges": [
    {
      "FromPort": 20,
      "ToPort": 20
    }
  ],
  "BackendPorts": [
    {
      "FromPort": "80",
      "ToPort": "80"
    }
  ],
  "Certificates": [
    {
      "Type": "Server",
      "Id": "449****-cn-hangzhou"
    }
  ],
  "Protocol": "tcp",
  "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
  "ClientAffinity": "SOURCE_IP",
  "Name": "Listener",
  "RelatedAcls": [
    {
      "AclId": "123",
      "Status": "off"
    }
  ],
  "AclType": "white",
  "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
  "ProxyProtocol": false,
  "XForwardedForConfig": {
    "XForwardedForGaIdEnabled": false,
    "XForwardedForGaApEnabled": false,
    "XForwardedForProtoEnabled": false,
    "XForwardedForPortEnabled": false,
    "XRealIpEnabled": 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"
}

错误码

HTTP status code	错误码	错误信息	描述
400	NotExist.Listener	listener %s is not exist	监听%s不存在。
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.	处理请求时出现错误，请稍后重试。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-03-27	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-11-06	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-08-15	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-04-06	OpenAPI 错误码发生变更	查看变更详情
2021-04-27	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情