调用DescribeListener接口查询全球加速实例下指定监听的配置信息。

使用说明

本接口用于查询全球加速实例下指定监听的配置信息,包括监听的状态、创建时间戳、端口信息等。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeListener

系统规定参数。取值:DescribeListener

RegionId String cn-hangzhou

全球加速实例所在的地域ID,仅取值cn-hangzhou

ListenerId String lsr-bp1bpn0kn908w4nbw****

要查询的监听的ID。

返回数据

名称 类型 示例值 描述
Description String Listener

监听的描述信息。

RequestId String 6FEA0CF3-D3B9-43E5-A304-D217037876A8

请求ID。

State String active

监听的状态。

  • active:正常。
  • creating:创建中。
  • configuring:配置中。
CreateTime String 1577786252000

创建监听的时间戳。

PortRanges Array of PortRanges

监听端口信息。

FromPort Integer 20

用来接收请求并向终端节点进行转发的起始监听端口。

说明 对于HTTP或HTTPS协议的监听,只支持配置一个监听端口,即返回的起始监听端口与结束监听端口相同。
ToPort Integer 20

用来接收请求并向终端节点进行转发的结束监听端口。

BackendPorts Array of BackendPort

后端端口信息。

FromPort String 80

后端服务器接收请求的起始端口。

当您的监听协议为HTTPS,且监听的端口和后端服务器提供服务的端口一致时才会返回该项。

ToPort String 80

后端服务器接收请求的结束端口。

Certificates Array of Certificate

SSL证书列表。

Type String Server

证书类型。

目前,仅支持返回Server(服务端证书)。

Id String 449****-cn-hangzhou

SSL证书ID。

Protocol String TCP

监听的网络传输协议类型。

  • tcp:TCP协议。
  • udp:UDP协议。
  • http:HTTP协议。
  • https:HTTPS协议。
ListenerId String lsr-bp1bpn0kn908w4nbw****

监听ID。

ClientAffinity String SOURCE_IP

客户端亲和性。

  • 返回为NONE时:不保持客户端亲和性,即不能确保来自同一客户端的连接请求始终定向到同一终端节点。
  • 返回为SOURCE_IP时,保持客户端亲和性。即客户端访问有状态的应用程序时,可以将来自同一客户端的所有请求都定向到同一终端节点,而不考虑源端口和协议。
Name String Listener

监听的名称。

RelatedAcls Array of relatedAcls

监听绑定的访问控制策略组信息。

AclId String 123

监听绑定的访问策略组ID。

Status String off

是否开启了访问控制功能。取值:

  • on:已开启。
  • off:未开启。
AclType String white

访问控制类型:

  • white:仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求,白名单适用于应用只允许特定IP访问的场景。设置白名单存在一定业务风险。一旦设置白名单,就只有白名单中的IP可以访问全球加速监听。如果开启了白名单访问,但访问策略组中没有添加任何IP,则全球加速监听不会转发请求。
  • black:来自所选访问控制策略组中设置的IP地址或地址段的所有请求都不会转发,黑名单适用于应用只限制某些特定IP访问的场景。如果开启了黑名单访问,但访问策略组中没有添加任何IP,则全球加速监听会转发全部请求。

Status参数的值为on时,返回该项。

AcceleratorId String ga-bp1odcab8tmno0hdq****

全球加速实例ID。

ProxyProtocol Boolean false

是否开启了保持客户端源IP功能。

  • true:开启了保持客户端源IP功能。开启后,支持后端服务查看客户端的原始IP地址。
  • false:未开启保持客户端源IP功能。
XForwardedForConfig Object

XForward字段配置信息。

XForwardedForGaIdEnabled Boolean false

是否通过GA-ID头字段获取全球加速实例ID。取值:

  • true:是。
  • false:否。
说明 仅HTTP和HTTPS监听支持此参数。
XForwardedForGaApEnabled Boolean false

是否通过GA-AP字段获取加速地域信息。取值:

  • true:是。
  • false:否。
说明 仅HTTP和HTTPS监听支持此参数。
XForwardedForProtoEnabled Boolean false

是否通过GA-X-Forward-Proto字段获取全球加速实例的监听协议。取值:

  • true:是。
  • false:否。
说明 仅HTTP和HTTPS监听支持此参数。
XForwardedForPortEnabled Boolean false

是否通过GA-X-Forward-Port字段获取全球加速实例的监听端口。取值:

  • true:是。
  • false:否。
说明 仅HTTP和HTTPS监听支持此参数。
XRealIpEnabled Boolean false

是否通过X-Real-IP字段获取真实的客户端IP。取值:

  • true:是。
  • false:否。
说明 仅HTTP和HTTPS监听支持此参数。
SecurityPolicyId String tls_cipher_policy_1_0

安全策略实例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监听支持此参数。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeListener
&RegionId=cn-hangzhou
&ListenerId=lsr-bp1bpn0kn908w4nbw****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeListenerResponse>
    <Description>Listener</Description>
    <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8	</RequestId>
    <State>active</State>
    <CreateTime>1577786252000</CreateTime>
    <PortRanges>
        <FromPort>20</FromPort>
        <ToPort>20</ToPort>
    </PortRanges>
    <BackendPorts>
        <FromPort>80</FromPort>
        <ToPort>80</ToPort>
    </BackendPorts>
    <Certificates>
        <Type>Server</Type>
        <Id>449****-cn-hangzhou</Id>
    </Certificates>
    <Protocol>TCP</Protocol>
    <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>
    <ClientAffinity>SOURCE_IP</ClientAffinity>
    <Name>Listener</Name>
    <RelatedAcls>
        <AclId>123</AclId>
        <Status>off</Status>
    </RelatedAcls>
    <AclType>white</AclType>
    <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>
    <ProxyProtocol>false</ProxyProtocol>
    <XForwardedForConfig>
        <XForwardedForGaIdEnabled>false</XForwardedForGaIdEnabled>
        <XForwardedForGaApEnabled>false</XForwardedForGaApEnabled>
        <XForwardedForProtoEnabled>false</XForwardedForProtoEnabled>
        <XForwardedForPortEnabled>false</XForwardedForPortEnabled>
        <XRealIpEnabled>false</XRealIpEnabled>
    </XForwardedForConfig>
    <SecurityPolicyId>tls_cipher_policy_1_0</SecurityPolicyId>
</DescribeListenerResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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"
}

错误码

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