GetListenerAttribute_网络型负载均衡_API文档-阿里云OpenAPI开发者门户

流控信息

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

授权信息

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

具体说明如下：展开详情

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

nlb:GetListenerAttribute	Get	LoadBalancer acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}	无	无

请求参数

字段名称	字段详情
ListenerIdstring	监听 ID。示例值:lsn-bp1bpn0kn908w4nbw****@233参考取值来源: ListListeners CreateListener
DryRunboolean	是否只预检此次请求。取值：展开详情示例值:false
ClientTokenstring	客户端 Token，用于保证请求的幂等性。展开详情示例值:123e4567-e89b-12d3-a456-426655440000
RegionIdstring	网络型负载均衡实例所在的地域 ID。展开详情示例值:cn-hangzhou参考取值来源: DescribeRegions SetHdMonitorRegionConfig

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:CEF72CEB-54B6-4AE8-B225-F876FF7BA984
RegionIdstring	网络型负载均衡实例所在的地域 ID。示例值:cn-hangzhou
LoadBalancerIdstring	网络型负载均衡实例 ID。示例值:nlb-83ckzc8d4xlp8o****
ListenerIdstring	监听 ID。示例值:lsn-bp1bpn0kn908w4nbw****@233
ListenerProtocolstring	监听协议。取值：TCP、UDP 或 TCPSSL。示例值:TCPSSL
ListenerPortinteger<int32>	监听端口。取值范围：0~65535。0：表示使用全端口监听。当设置为 0 时，您需要配置 StartPort 和 EndPort。示例值:233
StartPortstring	全端口监听起始端口。取值范围：0 ~ 65535。示例值:233
EndPortstring	全端口监听结束端口。取值范围：0~ 65535。结束端口的取值小于起始端口。示例值:455
ListenerDescriptionstring	自定义监听名称。展开详情示例值:tcpssl_443
ServerGroupIdstring	服务器组 ID。示例值:sgp-ppdpc14gdm3x4o****
IdleTimeoutinteger<int32>	连接空闲超时时间。单位：秒。示例值:900
SecurityPolicyIdstring	安全策略 ID。支持系统安全策略和自定义安全策略。展开详情示例值:tls_cipher_policy_1_0
CertificateIdsarray<string>	服务器证书列表信息。目前仅支持添加 1 个服务器证书。展开详情
CaCertificateIdsarray<string>	CA 证书列表信息。目前仅支持添加 1 个 CA 证书。展开详情
CaEnabledboolean	是否启动双向认证。取值：展开详情示例值:false
AlpnEnabledboolean	是否开启 ALPN。取值：展开详情示例值:false
AlpnPolicystring	ALPN 策略。取值：展开详情示例值:HTTP1Only
ProxyProtocolEnabledboolean	是否开启通过 Proxy Protocol 协议携带客户端源地址到后端服务器。取值：展开详情示例值:false
ProxyProtocolV2Configobject	通过 Proxy Protocol 协议携带 VpcId、PrivateLinkEpId、PrivateLinkEpsId 信息到后端服务器配置。
SecSensorEnabledboolean	是否开启秒级监控功能。取值：展开详情示例值:false
ListenerStatusstring	当前监听的状态，取值：展开详情示例值:Running
Cpsinteger<int32>	该监听在每个可用区（VIP）处理的每秒新建连接限速值。取值范围：0~1000000。0 表示不限速。示例值:1000
Mssinteger<int32>	TCP 报文的最大段大小。单位：字节，取值范围：0~1500。0 表示不修改用户 TCP 报文的 MSS 值。展开详情示例值:166
Tagsarray<object>	标签列表。

返回示例

错误码

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

全局错误码

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

400	SystemBusy	System is busy, please try again later.	诊断
404	ResourceNotFound.loadBalancer	The specified resource of loadbalancer is not found.	诊断
404	ResourceNotFound.listener	The specified resource %s is not found.	诊断

变更历史

	变更时间	变更内容概要	操作
	2024-02-04	新增错误码400
	2023-12-12	变更返回参数
	2023-11-27	删除错误码403 变更返回参数
	2023-10-10	新增错误码403
	2023-09-26	变更错误码404
	2023-09-12	新增错误码404
	2023-06-29	变更返回参数

1
2
10 条/页

GetListenerAttribute_网络型负载均衡_API文档

流控信息

授权信息

请求参数

返回参数

返回示例

错误码

变更历史

相关示例