更新监听的配置，如名称、默认动作等。
接口说明
UpdateListenerAttribute 接口属于异步接口，即系统返回一个请求 ID，但该监听的配置尚未更新成功，系统后台的更新任务仍在进行。您可以调用 GetListenerAttribute 查询监听的配置的更新状态：
- 当监听器处于 Configuring 状态时，表示监听的配置正在更新中。
- 当监听器处于 Running 状态时，表示监听的配置更新成功。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| alb:UpdateListenerAttribute | update | *LoadBalancer acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}*SecurityPolicy acs:alb:{#regionId}:{#accountId}:securitypolicy/{#securitypolicyId}*ServerGroup acs:alb:{#regionId}:{#accountId}:servergroup/{#servergroupId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ListenerId | string | 是 | 应用型负载均衡实例监听 ID。 | lsn-o4u54y73wq7b****** |
| ClientToken | string | 否 | 客户端 Token，用于保证请求的幂等性。 从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| 5A2CFF0E-5718-45B5-9D4D-70B****** |
| DryRun | boolean | 否 | 是否只预检此次请求。取值：
| false |
| ListenerDescription | string | 否 | 自定义监听名称。 长度为 2~256 个字符，可包含英文字母、数字、中文、半角逗号（,）、半角句号（.）、半角分号（;）、正斜线（/）、at（@）、下划线（_）和短划线（-）。 | HTTP_80 |
| RequestTimeout | integer | 否 | 指定请求超时时间。单位：秒。取值范围：1~180。 如果在超时时间内后端服务器一直没有响应，负载均衡将放弃等待，给客户端返回 | 3 |
| IdleTimeout | integer | 否 | 指定连接空闲超时时间。单位：秒。取值范围：1~60。 如果在超时时间内一直没有访问请求，负载均衡会暂时中断当前连接，直到下一次请求来临时重新建立新的连接。 | 15 |
| GzipEnabled | boolean | 否 | 是否开启 Gzip 压缩，对特定文件类型进行压缩。取值：
| true |
| Http2Enabled | boolean | 否 | 是否开启 HTTP/2 特性。取值：
说明
仅 HTTPS 监听支持此参数。
| true |
| SecurityPolicyId | string | 否 | 安全策略，支持系统安全策略和自定义安全策略。 说明
仅 HTTPS 监听支持此参数。
| tls_cipher_policy_1_0 |
| CaEnabled | boolean | 否 | 是否开启双向认证。取值：
| false |
| XForwardedForConfig | object | 否 | XForwardedFor 相关属性配置。 | |
| XForwardedForClientCertClientVerifyAlias | string | 否 | 自定义头字段名称，只有当 XForwardedForClientCertClientVerifyEnabled 的值为 true 时，此值才会生效。 取值限制：长度 1~40 个字符。支持字母 a~z、短划线（-）、下划线（_）和数字。 说明
仅 HTTPS 监听支持此参数。
| test_client-verify-alias_123456 |
| XForwardedForClientCertClientVerifyEnabled | boolean | 否 | 是否通过
说明
仅 HTTPS 监听支持此参数。
| false |
| XForwardedForClientCertFingerprintAlias | string | 否 | 自定义头字段名称，只有当 XForwardedForClientCertFingerprintEnabled 的值为 true 时生效。 取值限制：长度为 1~40 个字符。支持字母 a~z、短划线（-）、下划线（_）和数字。 说明
仅 HTTPS 监听支持此参数。
| test_finger-print-alias_123456 |
| XForwardedForClientCertFingerprintEnabled | boolean | 否 | 是否通过
说明
仅 HTTPS 监听支持此参数。
| false |
| XForwardedForClientCertIssuerDNAlias | string | 否 | 自定义头字段名称，只有当 XForwardedForClientCertIssuerDNEnabled 的值为 true 时才生效。 取值限制：长度为 1~40 个字符。支持字母 a~z、短划线（-）、下划线（_）和数字。 说明
仅 HTTPS 监听支持此参数。
| test_issue-dn-alias_123456 |
| XForwardedForClientCertIssuerDNEnabled | boolean | 否 | 是否通过
说明
仅 HTTPS 监听支持此参数。
| false |
| XForwardedForClientCertSubjectDNAlias | string | 否 | 自定义头字段名称，只有当 XForwardedForClientCertSubjectDNEnabled 的值为 true 时才生效。 取值限制：长度为 1~40 字符。支持字母 a~z、短划线（-）、下划线（_）和数字。 说明
仅 HTTPS 监听支持此参数。
| test_subject-dn-alias_123456 |
| XForwardedForClientCertSubjectDNEnabled | boolean | 否 | 是否通过
说明
仅 HTTPS 监听支持此参数。
| false |
| XForwardedForClientSrcPortEnabled | boolean | 否 | 是否通过
说明
HTTP 和 HTTPS 监听支持此参数。
| false |
| XForwardedForEnabled | boolean | 否 | 是否通过
说明
X-Forwarded-For头字段，不做额外处理。 | true |
| XForwardedForProcessingMode | string | 否 | 处理
说明
X-Forwarded-For头字段。X-Forwarded-For标头，无论请求是否携带X-Forwarded-For头字段。 | append |
| XForwardedForProtoEnabled | boolean | 否 | 是否通过
说明
HTTP、HTTPS 和 QUIC 监听支持此参数。
| false |
| XForwardedForSLBIdEnabled | boolean | 否 | 是否通过
说明
HTTP、HTTPS 和 QUIC 监听支持此参数。
| false |
| XForwardedForSLBPortEnabled | boolean | 否 | 是否通过
说明
HTTP、HTTPS 和 QUIC 监听支持此参数。
| false |
| XForwardedForClientSourceIpsEnabled | boolean | 否 | 是否允许 ALB 从 X-Forwarded-For 头字段中查找真实客户端 IP。取值：
说明
HTTP、HTTPS 监听支持此参数。
| false |
| XForwardedForClientSourceIpsTrusted | string | 否 | 指定可信的代理 IP。 应用型负载均衡 ALB 会从后往前遍历 | 10.1.1.0/24 |
| XForwardedForHostEnabled | boolean | 否 | 是否开启通过
说明
HTTP、HTTPS 和 QUIC 监听支持此参数。
| false |
| QuicConfig | object | 否 | 启用关联 QUIC 监听时的配置信息。 | |
| QuicListenerId | string | 否 | 需要关联的 QUIC 监听 ID。QuicUpgradeEnabled 值为 true 时必选。HTTPS 监听时有效。 说明
原始监听和关联的 QUIC 监听必须属于同一个 ALB 实例，并且此 QUIC 监听之前没有被关联过。
| lsn-333 |
| QuicUpgradeEnabled | boolean | 否 | 是否开启 QUIC 升级。取值：
说明
仅 HTTPS 监听时有效。
| false |
| Certificates | array<object> | 否 | 证书列表。最多支持添加 20 个证书。 说明
当前仅支持服务器证书。
| |
| object | 否 | 证书结构。 | ||
| CertificateId | string | 否 | 证书 ID。 | 123157****** |
| CaCertificates | array<object> | 否 | CA 证书列表。目前仅支持添加 1 个 CA 证书。 | |
| object | 否 | CA 证书结构。 | ||
| CertificateId | string | 否 | CA 证书 ID。 说明
当 CaEnabled 参数取值为 true 的时候，此参数为必填。
| 123359****** |
| DefaultActions | array<object> | 否 | 默认规则动作列表。 | |
| object | 否 | 默认规则动作结构。 | ||
| ForwardGroupConfig | object | 否 | 转发动作对应的配置，Type 类型为 ForwardGroup 时必填且有效。最多支持添加 20 个转发动作对应的配置。 | |
| ServerGroupTuples | array<object> | 是 | 转发目标服务器元组列表。 | |
| object | 否 | 转发目标服务器元组结构。 | ||
| ServerGroupId | string | 是 | 转发到的目的服务器组 ID。 | sgp-i5qt20****** |
| Type | string | 是 | 动作类型。最多支持添加 1 个动作类型。 取值：ForwardGroup，表示转发至多个服务器组。 | ForwardGroup |
返回参数
示例
正常返回示例
JSON格式
{
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
"RequestId": "365F4154-92F6-4AE4-92F8-7FF******"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | IncorrectStatus.LoadBalancer | The status of %s [%s] is incorrect. | 实例的当前状态不支持本次操作。 |
| 400 | IncorrectBusinessStatus.LoadBalancer | The business status of %s [%s] is incorrect. | 资源%s [%s]的业务状态无效。 |
| 400 | IncorrectStatus.Listener | The status of %s [%s] is incorrect. | 监听的当前状态不支持本次操作。 |
| 400 | OperationDenied.CrossLoadBalancerQUICListener | The operation is not allowed because of %s. | 操作被拒绝，原因是%s。 |
| 400 | ResourceAlreadyAssociated.Listener | The specified resource %s is already associated. | 资源%s已被关联。 |
| 400 | OperationDenied.GRPCServerGroup | The operation is not allowed because of %s. | 操作被拒绝，原因是存在绑定本GRPC服务器组的监听没有启用HTTP2.0。 |
| 400 | ResourceAlreadyAssociated.Certificate | The specified resource %s is already associated. | 证书已被关联。 |
| 400 | ResourceQuotaExceeded.SecurityPolicyAttachedNum | The quota of %s is exceeded for resource %s, usage %s/%s. | 配额%s已超额度限制，资源是%s，目前已使用%s，配额为%s。 |
| 400 | ResourceQuotaExceeded.ServerGroupAttachedNum | The quota of %s is exceeded for resource %s, usage %s/%s. | 服务器组可被关联数已超额度限制。 |
| 400 | ResourceQuotaExceeded.LoadBalancerServersNum | The quota of %s is exceeded for resource %s, usage %s/%s. | 后端服务器数已超额度限制。 |
| 400 | ResourceQuotaExceeded.ServerAddedNum | The quota of %s is exceeded for resource %s, usage %s/%s. | 服务器添加到组已超额度限制。 |
| 400 | OperationDenied.ServerGroupProtocolNotSupport | The operation is not allowed because of ServerGroupProtocolNotSupport. | 操作被拒绝，原因是ServerGroupProtocolNotSupport。 |
| 400 | UnsupportedFeature.FullTraceHttps | The feature of FullTraceHttps is not supported for current instance. | 当前实例版本不支持全链路HTTPS特性。 |
| 400 | ResourceInConfiguring.Listener | The specified resource of %s is being configured, please try again later. | 指定的资源%s正在配置中，请稍后再试。 |
| 400 | Mismatch.VpcId | The %s is mismatched for %s and %s. | %s在%s和%s中不匹配。 |
| 400 | InvalidParameter | Invalid parameter, please check the parameter input. | 无效参数，请检查参数输入。 |
| 403 | Forbidden.LoadBalancer | Authentication is failed for %s. | 负载均衡操作鉴权失败。 |
| 404 | ResourceNotFound.Listener | The specified resource %s is not found. | 监听不存在。 |
| 404 | ResourceNotFound.ServerGroup | The specified resource %s is not found. | 后端服务器组不存在。 |
| 404 | ResourceNotFound.SecurityPolicy | The specified resource %s is not found. | 资源%s不存在。 |
| 404 | ResourceNotFound.Certificate | The specified resource %s is not found. | 资源%s不存在。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-12-20 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2024-01-29 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2024-01-24 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-11-06 | OpenAPI 错误码发生变更 | 查看变更详情 |