最近更新时间:2023.11.16 15:51:40
首次发布时间:2021.08.31 10:37:27
调用 ModifyListenerAttributes 接口修改指定监听器。
名称 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ModifyListenerAttributes | 要执行的操作,取值为ModifyListenerAttributes。 |
Version | String | 是 | 2020-04-01 | API版本信息,当前版本为:2020-04-01。 |
ListenerId | String | 是 | lsn-2fek3rgsxhrsw5oxruwec**** | 监听器ID。您可以调用DescribeListeners接口获取监听器ID。 |
ListenerName | String | 否 | mylistener | 监听器的名称。
|
Scheduler | Sting | 否 | wrr | 监听器使用的调度算法。取值如下:
|
CertificateId | String | 否 | cert-bp1o94dp5i6ea**** | 监听器关联的证书ID。您可以调用DescribeCertificates接口获取证书ID。 |
EstablishedTimeout | Integer | 否 | 800 | 监听器的连接超时时间。取值如下:
|
AclStatus | String | 否 | off | 是否开启访问控制功能。取值如下:
AclType 和AclIds 参数。
说明
|
AclType | String | 否 | black | 访问控制的方式。取值如下:
说明 当 |
Bandwidth | Integer | 否 | 10 | 监听器的带宽峰值,单位为Mbps。
说明 监听器限速功能正在邀测中,如需使用,请提交工单或联系客户经理申请。 |
AclIds.N | String | 否 | AclIds.1=acl-3cj44nv0jhhxc6c6rrtet****&AclIds.2=acl-2febxt4pu0zy85oxruw0t**** | 监听器绑定的访问控制策略组ID。您可以调用DescribeAcls接口获取访问控制策略组ID。
说明 当 |
Enabled | String | 否 | off | 是否启用监听器。取值如下:
|
Description | String | 否 | This is a listener. | 监听器的描述。
|
ServerGroupId | String | 否 | rsp-bp1o94dp5i6ea**** | 监听器关联的后端服务组ID。
|
ProxyProtocolType | String | 否 | off | 是否启用PP协议。取值如下:
说明 参数 |
PersistenceType | String | 否 | off | 会话保持的类型。取值如下:
说明
|
PersistenceTimeout | Integer | 否 | 10 | 会话保持的超时时间。取值范围为1~3600,单位为秒。默认值为1000秒。 说明 参数 |
ConnectionDrainEnabled | String | 否 | on | 监听器是否开启连接优雅中断功能。取值如下:
说明
|
ConnectionDrainTimeout | Integer | 否 | 2 | 连接优雅中断的超时时间。取值范围为0~900,单位为秒。
|
HealthCheck.Enabled | String | 否 | on | 监听器是否开启健康检查功能。
说明 以下参数仅当本参数的值为 on 时有效。 |
HealthCheck.Timeout | Integer | 否 | 2 | 健康检查的响应超时时间,表示如果后端服务器在指定的时间内没有正确响应,则判定为健康检查“异常”。 说明 响应超时时间需小于等于检查时间间隔。 |
HealthCheck.HealthyThreshold | Integer | 否 | 3 | 健康检查的健康阈值,表示连续执行指定次数的健康检查,结果均为“正常”的后端服务器将被判定为健康检查“正常”。 |
HealthCheck.UnhealthyThreshold | Integer | 否 | 3 | 健康检查的不健康阈值,表示连续执行指定次数的健康检查,结果均为“异常”的后端服务器将被判定为健康检查异常。 |
HealthCheck.UdpRequest | String | 否 | Request123 | 健康检查的请求字符串。 说明
|
HealthCheck.UdpExpect | String | 否 | Expect123 | 健康检查的预期响应字符串。 说明
|
HealthCheck.Interval | Integer | 否 | 2 | 执行健康检查的时间间隔,取值范围为1 ~ 300,默认值为2,单位为秒。 |
HealthCheck.Method | String | 否 | HEAD | 监听器健康检查的方法。取值有以下几种:
说明 当参数 |
HealthCheck.Domain | String | 否 | www.test.com | 健康检查的域名,需配置为后端服务器上真实对外提供服务的地址。
说明 当参数 |
HealthCheck.URI | String | 否 | /test | 健康检查的路径,需配置为后端服务器上真实对外提供服务的地址。
说明 当参数 |
HealthCheck.HttpCode | String | 否 | "http_2xx,http_3xx" | 健康检查正常的HTTP状态码。取值如下:
说明 当参数 |
字段 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 20210811152539010225146063030**** | 请求ID。 |
GET /?Action=ModifyListenerAttributes&Version=2020-04-01&ListenerId=lsn-2fek3rgsxhrsw5oxruwec****&ListenerName=test&Scheduler=wlc HTTP/1.1 Host: open.volcengineapi.com Region: cn-beijing Service: clb
{ "ResponseMetadata": { "RequestId": "20210811152539010225146063030****", "Action": "ModifyListenerAttributes", "Version": "2020-04-01", "Service": "clb", "Region": "cn-beijing" }, "Result": { "RequestId": "20210811152539010225146063030****" } }
此处仅展示当前API的错误码,更多错误码请参见公共错误码。
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | MissingParameter | The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the 'XXX'. | 该请求缺少必要参数。请确保发起请求已提供全部必要参数,比如XXX。 说明 其中,XXX表示缺少的参数名称。 |
400 | InvalidPersistenceTimeout.Malformed | The specified PersistenceTimeout is malformed. | 指定的 PersistenceTimeout 参数格式不合法。 |
400 | InvalidPersistenceType.Malformed | The specified PersistenceType is malformed. | 指定的 PersistenceType 参数格式不合法。 |
400 | InvalidProtocol.Malformed | The specified Protocol is malformed. | 指定的 Protocol 参数格式不合法。 |
400 | InvalidProxyProtocolType.Malformed | The specified ProxyProtocolType is malformed. | 指定的 ProxyProtocolType 参数格式不合法。 |
400 | InvalidName.Malformed | The specified Name is malformed. | 指定的 Name 参数格式不合法。 |
400 | InvalidAclStatus.Malformed | The specified AclStatus is malformed. | 指定的 AclStatus 参数格式不合法。 |
400 | InvalidAclType.Malformed | The specified AclType is malformed. | 指定的 AclType 参数格式不合法。 |
400 | InvalidDescription.Malformed | The specified Description is malformed. | 指定的 Description 参数格式不合法。 |
400 | InvalidEnabled.Malformed | The specified Enabled is malformed. | 指定的 Enabled 参数格式不合法。 |
400 | InvalidEstablishedTimeout.Malformed | The specified EstablishedTimeout is malformed. | 指定的 EstablishedTimeout 参数格式不合法。 |
400 | InvalidHealthCheck.Domain.Malformed | The specified HealthCheck.Domain is malformed. | 指定的 HealthCheck.Domain 参数格式不合法。 |
400 | InvalidHealthCheck.Enabled.Malformed | The specified HealthCheck.Enabled is malformed. | 指定的 HealthCheck.Enabled 参数格式不合法。 |
400 | InvalidHealthCheck.HealthyThreshold.Malformed | The specified HealthCheck.HealthyThreshold is malformed. | 指定的 HealthCheck.HealthyThreshold 参数格式不合法。 |
400 | InvalidHealthCheck.HttpCode.Malformed | The specified HealthCheck.HttpCode is malformed. | 指定的 HealthCheck.HttpCode 参数格式不合法。 |
400 | InvalidHealthCheck.Interval.Malformed | The specified HealthCheck.Interval is malformed. | 指定的 HealthCheck.Interval 参数格式不合法。 |
400 | InvalidHealthCheck.Method.Malformed | The specified HealthCheck.Method is malformed. | 指定的 HealthCheck.Method 参数格式不合法。 |
400 | InvalidHealthCheck.Timeout.Malformed | The specified HealthCheck.Timeout is malformed. | 指定的 HealthCheck.Timeout 参数格式不合法。 |
400 | InvalidHealthCheck.URI.Malformed | The specified HealthCheck.URI is malformed. | 指定的 HealthCheck.URI 参数格式不合法。 |
400 | InvalidHealthCheck.UdpExpect.Malformed | The specified HealthCheck.UdpExpect is malformed. | 指定的 HealthCheck.UdpExpect 参数格式不合法。 |
400 | InvalidHealthCheck.UdpRequest.Malformed | The specified HealthCheck.UdpRequest is malformed. | 指定的 HealthCheck.UdpRequest 参数格式不合法。 |
400 | InvalidHealthCheck.UnhealthyThreshold.Malformed | The specified HealthCheck.UnhealthyThreshold is malformed. | 指定的 HealthCheck.UnhealthyThreshold 参数格式不合法。 |
400 | InvalidScheduler.Malformed | The specified Scheduler is malformed. | 指定的 Scheduler 参数格式不合法。 |
400 | InvalidBandwidth.Malformed | The specified Bandwidth is malformed. | 指定的 Bandwidth 参数格式不合法。 |
400 | InvalidLoadBalancer.InvalidStatus | The specified LoadBalancer is not in the correct status for the request. | 指定的负载均衡实例所处状态无法响应该请求。 |
400 | QuotaExceed.ListenerNumberEachAcl | You've reached the limit on the number of listeners that you can associate. | 已达到 ACL 可关联的监听器的数量的配额上限。 |
400 | LimitExceeded.AclNumbers | You've reached the limit on the number of ACL that you can associate. | 已达到可关联的 ACL 的数量上限。 |
400 | InvalidServerGroup.LoadBalancerMismatch | The specified ServerGroup and LoadBalancer are not matched. | 指定后端服务器组与负载均衡不匹配。 |
400 | UnsupportedOperation.AccountArrears | The request is denied due to the account arrears status. | 因账户处于欠费状态,该请求被拒绝。 |
400 | InvalidLoadBalancerOrAcl.UnSupportAction | The specified LoadBalancer or Acl status does not support this action. | 指定的负载均衡或者 ACL 状态不支持当前操作。 |
400 | InvalidListenerServerGroup.UnSupportAction | The specified Listener does not support this action. | 指定的监听器未绑定默认后端服务器组,不支持当前操作。 |
400 | UnsupportedOperation.AccountArrears | The request on the specified instance is denied due to the account in arrears status. | 因账户处于欠费状态,对于该实例的操作请求被拒绝。 |
400 | InvalidLoadBalancer.UnSupportAction | The specified LoadBalancer does not support this action. | 指定的负载均衡不支持当前操作。 |
400 | InvalidProtocol.ServerGroupIpVersionMismatch | The specified Protocol and ServerGroup IpVersion are not matched. | 指定的协议与服务器组 IP 版本不匹配。 |
400 | InvalidConnectionDrainEnabled.Malformed | The specified ConnectionDrainEnabled is malformed. | 指定的 ConnectionDrainEnabled 参数格式不合法。 |
400 | InvalidConnectionDrainTimeout.Malformed | The specified ConnectionDrainTimeout is malformed. | 指定的 ConnectionDrainTimeout 参数格式不合法。 |
400 | InvalidListener.UnSupportAction | The specified Listener does not support this action. | 指定的监听器不支持当前操作。 |
403 | InvalidResourceType.ServcieManaged | The specified ResourceType is managed by a service. | 指定的资源是服务托管资源。 |
403 | Forbidden | You are not authorized to perform operations on the specified service; for example, the 'Bandwidth'. | 无权限对指定服务进行操作,比如 Bandwidth。 |
404 | InvalidListener.NotFound | The specified Listener does not exist. | 指定的监听器不存在。 |
404 | InvalidSeverGroup.NotFound | The specified SeverGroup does not exist. | 指定的后端服务器组不存在。 |
404 | InvalidAcl.NotFound | The specified ACL does not exist. | 指定的 ACL 不存在。 |
404 | InvalidCertificate.NotFound | The specified Certificate does not exist. | 指定的证书不存在。 |
404 | InvalidExclusiveCluster.NotFound | The specified ExclusiveCluster does not exist. | 指定的独占集群不存在。 |
409 | InvalidOperation.Conflict | The specified resource operation conflicts. | 指定的资源操作冲突。 |
409 | InvalidAclId.Conflict | The specified AclId already exists. | 指定的 ACL 已存在。 |
412 | InvalidLoadBalancer.Expired | The specified LoadBalancer has expired. | 指定的负载均衡已过期。 |
412 | InvalidExclusiveCluster.Expired | The specified ExclusiveCluster has expired. | 指定的独占集群已过期。 |
412 | InvalidExclusiveCluster.UnPurchased | The specified ExclusiveCluster is not purchased. | 指定的独占集群未购买。 |