UpdateListenerAttribute_网络型负载均衡_API文档

2022-04-30

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

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

授权信息

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

具体说明如下：展开详情

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

nlb:UpdateListenerAttribute	Update	LoadBalancer acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}	无	无

请求参数

字段名称	字段详情
ListenerIdstring	监听实例 ID。示例值:lsn-bp1bpn0kn908w4nbw****@443参考取值来源: ListListeners CreateListener
ListenerDescriptionstring	自定义监听名称。展开详情示例值:tcpssl_443
ServerGroupIdstring	服务器组 ID。展开详情示例值:sgp-ppdpc14gdm3x4o****参考取值来源: ListServerGroups CreateServerGroup AddServersToServerGroup UpdateServerGroupAttribute
SecurityPolicyIdstring	安全策略 ID。展开详情示例值:tls_cipher_policy_1_1参考取值来源: ListSecurityPolicy CreateSecurityPolicy UpdateSecurityPolicyAttribute
CertificateIdsarray<string>	服务器证书列表信息。目前仅支持添加 1 个服务器证书。展开详情子级条数 <= 10
CaCertificateIdsarray<string>	CA 证书列表信息。目前仅支持添加 1 个 CA 证书。展开详情子级条数 <= 10
CaEnabledboolean	是否启动双向认证。取值：展开详情示例值:false
IdleTimeoutinteger<int32>	连接空闲超时时间。单位：秒。展开详情示例值:900取值 <= 3600
DryRunboolean	是否只预检此次请求。取值：展开详情示例值:false
ClientTokenstring	客户端 Token，用于保证请求的幂等性。展开详情示例值:123e4567-e89b-12d3-a456-426655440000
RegionIdstring	网络型负载均衡实例所在的地域 ID。展开详情示例值:cn-hangzhou参考取值来源: DescribeRegions SetHdMonitorRegionConfig
ProxyProtocolEnabledboolean	是否开启通过 Proxy Protocol 协议携带客户端源地址到后端服务器。取值：展开详情示例值:false
SecSensorEnabledboolean	是否开启秒级监控功能。取值：展开详情示例值:false
AlpnEnabledboolean	是否开启 ALPN。取值：展开详情示例值:false
AlpnPolicystring	ALPN 策略。取值：展开详情示例值:HTTP1Only枚举值:HTTP1OnlyHTTP2OnlyHTTP2PreferredHTTP2Optional
Cpsinteger<int32>	该监听在每个可用区（VIP）处理的每秒新建连接限速值。取值范围：0~1000000。0 表示不限速。示例值:10000
Mssinteger<int32>	TCP 报文的最大段大小。单位：字节，取值范围：0~1500。0 表示不修改用户 TCP 报文的 MSS 值。仅 TCP、TCPSSL 类型的监听支持该字段值。示例值:344
ProxyProtocolV2Configobject	通过 Proxy Protocol 协议携带 VpcId、PrivateLinkEpId、PrivateLinkEpsId 信息到后端服务器配置。

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:CEF72CEB-54B6-4AE8-B225-F876FF7BA984
JobIdstring	异步任务 ID。示例值:72dcd26b-f12d-4c27-b3af-18f6aed5****

返回示例

错误码

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

全局错误码

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

400	Mismatch.VpcId	The VpcId is mismatched for %s and %s.	诊断
400	Conflict.Port	The Port [%s] is conflict.	诊断
400	ResourceNotFound.Certificate	The specified resource %s is not found.	诊断
400	IncorrectStatus.listener	The status of listener [%s] is incorrect.	诊断
400	IdempotenceSignatureMismatch	The idempotence token of request is same with the prev one, but the signature is different.	诊断
400	DryRunOperation	Request validation has been passed with DryRun flag set.	诊断
400	ResourceAlreadyAssociated.Certificate	The specified resource %s is already associated.	诊断
400	IllegalParamSize.certificateIds	The param size of certificateIds or caCertificateIds is illegal.	诊断
400	SystemBusy	System is busy, please try again later.	诊断
400	IllegalParam.IdleTimeout	The param of IdleTimeout is illegal.	诊断
400	OperationDenied.RegionNotSupportHDMonitor	The operation is not allowed because of RegionNotSupportHDMonitor.	诊断
400	ResourceNotEnough.CaCertificateApiCount	The specified resource of CaCertificateApiCount is not enough.	诊断
400	IllegalParam	The param of %s is illegal.	诊断
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	诊断
404	ResourceNotFound.listener	The specified resource %s is not found.	诊断
404	ResourceNotFound.HdMonitorConfigNotExist	The specified resource of HdMonitorConfigNotExist is not found.	诊断
404	ResourceNotFound.CaCertificate	The specified resource of CaCertificate is not found.	诊断
404	ResourceNotFound.securitypolicy	The specified resource of securitypolicy is not found.	诊断

变更历史

	变更时间	变更内容概要	操作
	2025-02-14	删除返回参数
	2024-08-27	变更请求参数IdleTimeout
	2024-02-29	变更错误码400 变更错误码404
	2024-02-22	变更错误码400 变更错误码404
	2024-02-04	变更错误码400
	2024-01-30	变更请求参数IdleTimeout
	2024-01-29	变更错误码400 变更错误码404
	2024-01-24	变更错误码400

1
2
3
10 条/页

相关示例