本接口用于为负载均衡实例添加监听器。
前提条件:
使用限制:
下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数,请参见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | AddLBListener | 公共参数。该参数表示接口名称。取值:AddLBListener。 |
Version | String | 是 | 2021-04-30 | 公共参数。该参数表示接口版本。取值:2021-04-30。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | AddLBListener | 公共参数。该参数表示接口名称。取值:AddLBListener。 |
Version | String | 是 | 2021-04-30 | 公共参数。该参数表示接口版本。取值:2021-04-30。 |
lb_identity | String | 是 | veew-lb2131011027612112**** | 负载均衡实例的 ID。您可以通过 ListLBs 接口查询负载均衡实例的 ID。 |
name | String | 是 | listener-1 | 监听器的名称。命名规则如下:
|
listen_port_protocol | String | 是 | TCP | 监听协议,也称前端协议:
|
listen_port | Integer | 是 | 80 | 监听端口,也称前端端口。取值范围:1~65535。 |
loadbalance_strategy | String | 是 | sip | 负载均衡策略。取值范围:
|
endpoints | 是 |
| 后端服务器列表。 说明 添加的后端服务器的公网类型需与负载均衡实例的公网类型一致。 | |
health_check | 否 |
| 健康检查配置。 | |
desc | String | 否 | This is a test | 监听器的描述。最多可输入 256 个字符。 |
default_endpoint_port | Integer | 否 | 80 | 默认后端端口。默认值:与前端端口相同。取值范围:1~65535。 |
该接口无特有的返回参数。
POST https://veenedge.volcengineapi.com/?Action=AddLBListener&Version=2021-04-30 &<其他公共参数> { "lb_identity": "veew-lb2063021453005555****", "name": "listener-1", "listen_port_protocol": "TCP", "listen_port": 80, "loadbalance_strategy": "sip", "endpoints": [ { "endpoint_identity": "veen8580100583220550****", "endpoint_type": "veen", "port": 80 } ], "health_check": { "failure_threshold": 2, "port": 80, "period": 10, "protocol": "TCP", "success_threshold": 2, "timeout": 10, "use_endpoint_port": false } }
{ "ResponseMetadata": { "RequestId": "202305311418124563864534F61CAB****", "Action": "AddLBListener", "Version": "2021-04-30", "Service": "veenedge", "Region": "cn-north-1" } }
如果响应正文中包含 Error 字段,则表示 API 请求失败。关于错误码的更多信息,参见错误码。