1)接口功能介绍
创建TCP监听。
2)接口约束
要注意前端协议端口范围,描述不要大于255个字符。
3)URI
POST /v1/createLoadBalancerTCPListener。
4)请求参数
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
slbId | 是 | String | 负载均衡器ID | 232 | |
name | 是 | String | 监听器名称。名称格式支持字母、数字、中文、下划线、中划线、点。sdk默认会生成该字段,建议格式为:listener-***。命名要求:小写字母、数字或中划线(-)组成;小写字母开头;数字或小写字母结尾;长度不超过64。 | listener-042a3d | |
port | 是 | Integer | 前端协议端口 。取值范围:(0,65535] | 443 | |
slbBackendGroupId | 是 | String | 后端服务器组ID 。转发到的后端服务器组ID。前后端协议类型需要匹配;前端协议类型为HTTP与HTTPS时,服务器组的后端协议类型为HTTP。通过GetBackendGroupList接口获取 | 3453 | |
description | 否 | String | 监听器描述。最大不超过255个字符 | sdk-test |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
slbListenerId | 是 | String | 负载均衡监听器ID | 22 |
6)请求示例
请求体body
{
"slbId": "3016",
"name": "slb-tcp-勿删-5159",
"port": 24,
"description": "test",
"slbBackendGroupId": "5159"
}
7)响应示例
{
"requestId": "525e58d1-073e-4b02-ae6c-12cf74c1e36d",
"status": {
"code": "Success",
"message": "Success"
},
"data": {
"slbListenerId": "345"
}
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |