UpdateListenerAttribute_应用型负载均衡_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

UpdateListenerAttribute 接口属于异步接口,即系统返回一个请求 ID,但该监听的配置尚未更新成功,系统后台的更新任务仍在进行。您可以调用 GetListenerAttribute 查询监听的配置的更新状态:

  • 当监听器处于 Configuring 状态时,表示监听的配置正在更新中。
  • 当监听器处于 Running 状态时,表示监听的配置更新成功。

流控信息

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

授权信息

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

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
alb:UpdateListenerAttribute
Update
LoadBalancer
acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
SecurityPolicy
acs:alb:{#regionId}:{#accountId}:securitypolicy/{#securitypolicyId}
ServerGroup
acs:alb:{#regionId}:{#accountId}:servergroup/{#servergroupId}

请求参数

字段名称字段详情
ListenerIdstring

应用型负载均衡实例监听 ID。

示例值:lsn-o4u54y73wq7b******参考取值来源:
    ListListeners
    CreateListener
ClientTokenstring

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

示例值:5A2CFF0E-5718-45B5-9D4D-70B******
DryRunboolean

是否只预检此次请求。取值:展开详情

示例值:false
ListenerDescriptionstring

自定义监听名称。展开详情

示例值:HTTP_80
RequestTimeoutinteger<int32>

指定请求超时时间。单位:秒。取值范围:1~180展开详情

示例值:3取值 >= 1
IdleTimeoutinteger<int32>

指定连接空闲超时时间。单位:秒。取值范围:1~60展开详情

示例值:15取值 >= 1
GzipEnabledboolean

是否开启 Gzip 压缩,对特定文件类型进行压缩。取值:展开详情

示例值:true
Http2Enabledboolean

是否开启 HTTP/2 特性。取值:展开详情

示例值:true
SecurityPolicyIdstring

安全策略,支持系统安全策略和自定义安全策略。展开详情

示例值:tls_cipher_policy_1_0参考取值来源:
    CreateSecurityPolicy
    ListSecurityPolicies
CaEnabledboolean

是否开启双向认证。取值:展开详情

示例值:false
XForwardedForConfigobject

XForwardedFor 相关属性配置。

QuicConfigobject

启用关联 QUIC 监听时的配置信息。

Certificatesarray<object>

证书列表。最多支持添加 20 个证书。展开详情

子级条数 <= 2子级条数 >= 1
CaCertificatesarray<object>

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

子级条数 <= 1子级条数 >= 1
DefaultActionsarray<object>

默认规则动作列表。

返回参数

字段名称字段详情
JobIdstring

异步任务 ID。

示例值:72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestIdstring

请求 ID。

示例值:365F4154-92F6-4AE4-92F8-7FF******

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
IncorrectStatus.LoadBalancer
The status of %s [%s] is incorrect.诊断
400
IncorrectBusinessStatus.LoadBalancer
The business status of %s [%s]  is incorrect.诊断
400
IncorrectStatus.Listener
The status of %s [%s] is incorrect.诊断
400
OperationDenied.CrossLoadBalancerQUICListener
The operation is not allowed because of %s.诊断
400
ResourceAlreadyAssociated.Listener
The specified resource %s is already associated.诊断
400
OperationDenied.GRPCServerGroup
The operation is not allowed because of %s.诊断
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.诊断
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.诊断
400
UnsupportedFeature.FullTraceHttps
The feature of FullTraceHttps is not supported for current instance.诊断
400
ResourceInConfiguring.Listener
The specified resource of %s is being configured, please try again later.诊断
400
Mismatch.VpcId
The %s is mismatched for %s and %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.诊断
404
ResourceNotFound.Certificate
The specified resource %s is not found.诊断

变更历史

变更时间变更内容概要操作
2024-12-20
变更请求参数XForwardedForConfig
2024-01-29
变更错误码400
2024-01-24
变更错误码400
新增错误码403
2023-11-06
变更请求参数CaCertificates
2020-09-29
变更请求参数RequestTimeout
  • 1
  • 2
  • 10 条/页

相关示例

停止一个alb监听实例并删除
2021-09-27
2024年08月20日