文档

UpdateListenerAttribute - 更新监听配置

更新时间:

更新网络型负载均衡监听的配置。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
nlb:UpdateListenerAttributeWrite
  • LoadBalancer
    acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

请求参数

名称类型必填描述示例值
ListenerIdstring

监听实例 ID。

lsn-bp1bpn0kn908w4nbw****
ListenerDescriptionstring

自定义监听名称。

长度限制为 2~256 个字符,支持中文和英文字母,可包含数字、半角逗号(,)、半角句号(.)、半角分号(;)、正斜线(/)、at(@)、下划线(_)和短划线(-)。

tcpssl_443
ServerGroupIdstring

服务器组 ID。

sgp-ppdpc14gdm3x4o****
SecurityPolicyIdstring

安全策略 ID。

说明 仅对 TCPSSL 监听生效。
tls_cipher_policy_1_1
CertificateIdsarray

服务器证书列表信息。目前仅支持添加 1 个服务器证书。

说明 仅对 TCPSSL 监听生效。
string

服务器证书列表信息。目前仅支持添加 1 个服务器证书。

说明 仅对 TCPSSL 监听生效。
123157******
CaCertificateIdsarray

CA 证书列表信息。目前仅支持添加 1 个 CA 证书。

说明 仅对 TCPSSL 监听生效。
string

CA 证书列表信息。目前仅支持添加 1 个 CA 证书。

说明 仅对 TCPSSL 监听生效。
139a00******
CaEnabledboolean

是否启动双向认证。取值:

  • true:启动。

  • false(默认值):关闭。

false
IdleTimeoutinteger

连接空闲超时时间。单位:秒。取值范围:1~900

900
DryRunboolean

是否只预检此次请求。取值:

  • true:发送检查请求,不会更新监听信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接进行操作。
false
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-426655440000
RegionIdstring

网络型负载均衡实例所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
ProxyProtocolEnabledboolean

是否开启通过 Proxy Protocol 协议携带客户端源地址到后端服务器。取值:

  • true:开启。

  • false:关闭。

false
SecSensorEnabledboolean

是否开启秒级监控功能。取值:

  • true:开启。

  • false:关闭。

false
AlpnEnabledboolean

是否开启 ALPN。取值:

  • true:开启。

  • false:关闭。

false
AlpnPolicystring

ALPN 策略。取值:

  • HTTP1Only:只协商使用 HTTP1.x 协议,优先级为 HTTP1.1>HTTP1.0。
  • HTTP2Only:只协商使用 HTTP2.0 协议。
  • HTTP2Optional:优先使用 HTTP1.x 协议,但也接受 HTTP2.0 协议,优先级为 HTTP1.1>HTTP1.0>HTTP2.0。
  • HTTP2Preferred:优先使用 HTTP2.0 协议,但也接受 HTTP1.x 协议,优先级为 HTTP2.0>HTTP1.1>HTTP1.0。
说明 AlpnEnabled 开启后需配置该参数。
HTTP1Only
Cpsinteger

网络型负载均衡实例每秒新建连接限速值。取值范围:0~10000000 表示不限速。

10000
Mssinteger

TCP 报文的最大段大小。单位:字节,取值范围:0~15000 表示不修改用户 TCP 报文的 MSS 值。仅 TCP、TCPSSL 类型的监听支持该字段值。

344
ProxyProtocolV2Configobject

通过 Proxy Protocol 协议携带 VpcId、PrivateLinkEpId、PrivateLinkEpsId 信息到后端服务器配置。

Ppv2VpcIdEnabledboolean

是否开启通过 Proxy Protocol 协议携带 VpcId 到后端服务器。取值:

  • true:开启。

  • false:关闭。

false
Ppv2PrivateLinkEpIdEnabledboolean

是否开启通过 Proxy Protocol 协议携带 PrivateLinkEpId 到后端服务器。取值:

  • true:开启。

  • false:关闭。

false
Ppv2PrivateLinkEpsIdEnabledboolean

是否开启通过 Proxy Protocol 协议携带 PrivateLinkEpsId 到后端服务器。取值:

  • true:开启。

  • false:关闭。

false

返回参数

名称类型描述示例值
object

更新监听配置。

RequestIdstring

请求 ID。

CEF72CEB-54B6-4AE8-B225-F876FF7BA984
JobIdstring

异步任务 ID。

72dcd26b-f12d-4c27-b3af-18f6aed5****

示例

正常返回示例

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

错误码

HTTP status code错误码错误信息描述
400Mismatch.VpcIdThe VpcId is mismatched for %s and %s.资源%s和资源%s的VpcId不匹配。请检查两种资源是否在同一个VPC下。
400Conflict.PortThe Port [%s] is conflict.指定端口与已有端口存在冲突
400ResourceNotFound.CertificateThe specified resource %s is not found.资源%s不存在。
400IncorrectStatus.listenerThe status of listener [%s] is incorrect.监听的状态无法进行当前操作,请检查监听当前是否处于其他操作下。
400IdempotenceSignatureMismatchThe idempotence token of request is same with the prev one, but the signature is different.请求的幂等令牌与上一个相同,但签名不同。
400DryRunOperationRequest validation has been passed with DryRun flag set.dryRun请求验证已通过。
400ResourceAlreadyAssociated.CertificateThe specified resource %s is already associated.资源%s已被关联。
400IllegalParamSize.certificateIdsThe param size of certificateIds or caCertificateIds is illegal.证书的id只能有一个,请检查是否重复输入。
400SystemBusySystem is busy, please try again later.系统繁忙,请稍后重试
400IllegalParam.IdleTimeoutThe param of IdleTimeout is illegal.参数连接空闲超时时间配置非法。
400OperationDenied.RegionNotSupportHDMonitorThe operation is not allowed because of RegionNotSupportHDMonitor.当前区域不支持秒级监控。
400ResourceNotEnough.CaCertificateApiCountThe specified resource of CaCertificateApiCount is not enough.触发证书服务限流,请稍后重试。
400IllegalParamThe param of %s is illegal.输入的参数有值非法,请检查输入。
403Forbidden.NoPermissionAuthentication is failed for NoPermission.因为账号没有权限,所以鉴权失败。
404ResourceNotFound.listenerThe specified resource %s is not found.资源%s不存在。
404ResourceNotFound.HdMonitorConfigNotExistThe specified resource of HdMonitorConfigNotExist is not found.HdMonitorConfig 不存在,请检查输入参数。
404ResourceNotFound.CaCertificateThe specified resource of CaCertificate is not found.Ca证书不存在,请检查输入参数。
404ResourceNotFound.securitypolicyThe specified resource of securitypolicy is not found.找不到指定的安全策略资源。请检查输入参数。

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

变更历史

变更时间变更内容概要操作
2024-02-29OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    错误码 404 变更
    删除错误码:403
2024-02-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    错误码 404 变更
    删除错误码:403
2024-02-04OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
2024-01-30OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
2024-01-29OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    错误码 404 变更
    删除错误码:403
2024-01-24OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
2023-12-18OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
2023-11-27OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:ProxyProtocolV2Config
2023-09-26OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    新增错误码:404
2023-09-05OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    错误码 403 变更
2023-08-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:400
    新增错误码:403
2023-04-04API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用