调用GetListenerAttribute接口查询网络型负载均衡实例的监听详情

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	GetListenerAttribute	系统规定参数。取值：GetListenerAttribute。
ListenerId	String	是	lsn-bp1bpn0kn908w4nbw****	监听ID。
DryRun	Boolean	否	false	是否只预检此次请求。取值： true：发送检查请求，不会查询监听详情。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。
ClientToken	String	否	123e4567-e89b-12d3-a456-426655440000	客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。说明若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。
RegionId	String	否	cn-hangzhou	网络型负载均衡实例所在的地域ID。您可以通过调用DescribeRegions接口获取地域ID。

返回数据


名称	类型	示例值	描述
RequestId	String	CEF72CEB-54B6-4AE8-B225-F876FF7BA984	请求ID。
RegionId	String	cn-hangzhou	网络型负载均衡实例所在的地域ID。
LoadBalancerId	String	nlb-83ckzc8d4xlp8o****	网络型负载均衡实例ID。
ListenerId	String	lsn-ga6sjjcll6ou34l1et****	监听ID。
ListenerProtocol	String	TCPSSL	监听协议。取值：TCP、UDP或TCPSSL。
ListenerPort	Integer	233	监听端口。取值范围：0~65535。0：表示使用全端口监听。当设置为0时，您需要配置StartPort和EndPort。
StartPort	String	233	全端口监听起始端口。取值范围：0 ~ 65535。
EndPort	String	455	全端口监听结束端口。取值范围：0~ 65535。结束端口的取值小于起始端口。
ListenerDescription	String	tcpssl_443	自定义监听名称。长度限制为2~256个字符，支持中文和英文字母，可包含数字、半角逗号（,）、半角句号（.）、半角分号（;）、正斜线（/）、at（@）、下划线（_）和短划线（-）。
ServerGroupId	String	sgp-ppdpc14gdm3x4o****	服务器组ID。
IdleTimeout	Integer	900	连接空闲超时时间。单位：秒。取值范围：1~900。
SecurityPolicyId	String	tls_cipher_policy_1_0	安全策略ID。支持系统安全策略和自定义安全策略。系统策略取值：tls_cipher_policy_1_0（默认值）、tls_cipher_policy_1_1、tls_cipher_policy_1_2、tls_cipher_policy_1_2_strict或tls_cipher_policy_1_2_strict_with_1_3。自定义安全策略：输入自定义安全策略ID。创建自定义策略，请参见CreateSecurityPolicy。查询安全策略，请参见ListSecurityPolicy。说明仅对TCPSSL监听生效。
CertificateIds	Array of String	12315790212_166f8204689_1714763408_70998****	服务器证书列表信息。目前仅支持添加1个服务器证书。说明该参数仅对TCPSSL监听生效。
CaCertificateIds	Array of String	139a00604ad-cn-east-hangzh****	CA证书列表信息。目前仅支持添加1个CA证书。说明该参数仅对TCPSSL监听生效。
CaEnabled	Boolean	false	是否启动双向认证。取值： true：启动。 false：关闭。
AlpnEnabled	Boolean	false	是否开启ALPN。取值： true：开启。 false：关闭。
AlpnPolicy	String	HTTP1Only	ALPN策略。取值： HTTP1Only HTTP2Only HTTP2Preferred HTTP2Optional
ProxyProtocolEnabled	Boolean	false	是否开启通过Proxy Protocol协议携带客户端源地址到后端服务器。取值： true：开启。 false：关闭。
SecSensorEnabled	Boolean	false	是否开启秒级监控功能。取值： true：开启。 false：关闭。
ListenerStatus	String	Running	当前监听的状态，取值： Provisioning：创建中。 Running：运行中。 Configuring：配置中。 Stopping：停止中。 Stopped：已停止。 Starting：启动中。 Deleting：删除中。 Deleted：已删除。
Cps	Integer	1000	网络型负载均衡实例每秒新建连接限速值。取值范围：0~1000000。0表示不限速。
Mss	Integer	166	TCP报文的最大段大小。单位：字节，取值范围：0~1500。0表示不修改用户TCP报文的MSS值。说明仅TCP、TCPSSL类型的监听支持该字段值。

示例

请求示例

http(s)://[Endpoint]/?Action=GetListenerAttribute
&ListenerId=lsn-bp1bpn0kn908w4nbw****
&DryRun=false
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

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

<GetListenerAttributeResponse>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
    <RegionId>cn-hangzhou</RegionId>
    <LoadBalancerId>nlb-83ckzc8d4xlp8o****</LoadBalancerId>
    <ListenerId>lsn-ga6sjjcll6ou34l1et****</ListenerId>
    <ListenerProtocol>TCPSSL</ListenerProtocol>
    <ListenerPort>233</ListenerPort>
    <StartPort>233</StartPort>
    <EndPort>455</EndPort>
    <ListenerDescription>tcpssl_443</ListenerDescription>
    <ServerGroupId>sgp-ppdpc14gdm3x4o****</ServerGroupId>
    <IdleTimeout>900</IdleTimeout>
    <SecurityPolicyId>tls_cipher_policy_1_0</SecurityPolicyId>
    <CertificateIds>12315790212_166f8204689_1714763408_70998****</CertificateIds>
    <CaCertificateIds>139a00604ad-cn-east-hangzh****</CaCertificateIds>
    <CaEnabled>false</CaEnabled>
    <AlpnEnabled>false</AlpnEnabled>
    <AlpnPolicy>HTTP1Only</AlpnPolicy>
    <ProxyProtocolEnabled>false</ProxyProtocolEnabled>
    <SecSensorEnabled>false</SecSensorEnabled>
    <ListenerStatus>Running</ListenerStatus>
    <Cps>1000</Cps>
    <Mss>166</Mss>
</GetListenerAttributeResponse>

JSON格式

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

{
  "RequestId" : "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "RegionId" : "cn-hangzhou",
  "LoadBalancerId" : "nlb-83ckzc8d4xlp8o****",
  "ListenerId" : "lsn-ga6sjjcll6ou34l1et****",
  "ListenerProtocol" : "TCPSSL",
  "ListenerPort" : 233,
  "StartPort" : "233",
  "EndPort" : "455",
  "ListenerDescription" : "tcpssl_443",
  "ServerGroupId" : "sgp-ppdpc14gdm3x4o****",
  "IdleTimeout" : 900,
  "SecurityPolicyId" : "tls_cipher_policy_1_0",
  "CertificateIds" : [ "12315790212_166f8204689_1714763408_70998****" ],
  "CaCertificateIds" : [ "139a00604ad-cn-east-hangzh****" ],
  "CaEnabled" : false,
  "AlpnEnabled" : false,
  "AlpnPolicy" : "HTTP1Only",
  "ProxyProtocolEnabled" : "false",
  "SecSensorEnabled" : "false",
  "ListenerStatus" : "Running",
  "Cps" : 1000,
  "Mss" : 166
}

错误码

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