本接口用于编辑负载均衡实例的监听器。您可以通过该接口修改监听器的名称、描述、负载均衡策略、和健康检查配置。
下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数,请参见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | EditLBListener | 公共参数。该参数表示接口名称。取值:EditLBListener。 |
Version | String | 是 | 2021-04-30 | 公共参数。该参数表示接口版本。取值:2021-04-30。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
lb_identity | String | 是 | veew-lb2131011027612112**** | 负载均衡实例的 ID。您可以通过 ListLBs 接口查询负载均衡实例的 ID。 |
listen_port | Integer | 是 | 80 | 监听端口。该参数不能修改,用于指定需要修改的监听器。 |
listen_port_protocol | String | 是 | TCP | 监听协议。取值范围:
该参数不能修改,用于指定需要修改的监听器。 |
name | String | 是 | listener-1 | 监听器的名称。命名规则如下:
|
loadbalance_strategy | String | 是 | sip | 负载均衡算法。取值范围:
|
desc | String | 否 | test | 监听器的描述。最多可输入 256 个字符。 |
close_health_check | Boolean | 否 | false | 是否关闭健康检查。取值范围:
|
health_check | 否 |
| 健康检查配置。 | |
idle_timeout | Integer | 否 | 60 | 连接空闲超时时间。如果已建立的连接上一直没有数据传输且该情况的持续时长达到设置的空闲超时时间时,负载均衡会断开连接。
|
connection_drain_config | 否 |
| “连接优雅中断”功能配置。
|
该接口无特有的返回参数。
POST https://veenedge.volcengineapi.com/?Action=EditLBListener&Version=2021-04-30 &<其他公共参数> { "lb_identity": "veew-lb2131011027612112****", "listen_port": 80, "listen_port_protocol": "TCP", "name": "listener-1", "close_health_check": true, "loadbalance_strategy": "sip" }
{ "ResponseMetadata": { "RequestId": "202305311509582C0B6C9A2AEA21EF****", "Action": "EditLBListener", "Version": "2021-04-30", "Service": "veenedge", "Region": "cn-north-1" } }
如果响应正文中包含 Error 字段,则表示 API 请求失败。关于错误码的更多信息,参见错误码。