1)接口功能介绍
创建后端服务器组。
2)接口约束
slb需先存在,方可创建后端服务器组。
3)URI
POST /v1/createBackendGroup。
4)请求参数
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
name | 是 | String | 后端服务器组名称。命名要求:大小写字母、数字或中划线(-)组成;大小写字母开头;数字或大小写字母结尾;长度不超过64。建议格式为:service-group-*** 。如果不填,sdk默认会生成该字段。 | my-test-backend-group | |
slbId | 是 | String | 负载均衡id。可通过查询负载均衡列表(describeLoadBalancers)接口获取 | 172 | |
protocol | 是 | String | 后端协议类型 PROTOCOL_TCP,PROTOCOL_HTTP,PROTOCOL_UDP | PROTOCOL_HTTP | |
balancePolicy | 是 | String | 负载均衡策略。BALANCE_POLICY_ROUND_ROBIN-轮询 , BALANCE_POLICY_IP_HASH-IP hash , BALANCE_POLICY_LEAST_CONNECT-加权最少连接数。后端协议未HTTP时,balancePolicy只可填BALANCE_POLICY_ROUND_ROBIN,BALANCE_POLICY_IP_HASH | BALANCE_POLICY_ROUND_ROBIN | |
enableSessionPersistence | 否 | Boolean | 是否启用会话保持。默认为false。 内网SLB的后端服务器组不能启用会话保持。只有加权轮询时,该字段生效 | false | |
sessionPersistenceTimeout | 否 | Integer | 会话保持时间。protocol为TCP或UDP、enableSessionPersistence为true时需要填写。要求取值范围为1~60,默认值5,单位:分钟。 | 60 | |
sessionPersistenceType | 否 | String | 会话保持类型。SESSION_PERSISTENCE_TYPE_LOAD_BALANCE_COOKIE-负载均衡器cookie,SESSION_PERSISTENCE_TYPE_APPLICATION_COOKIE-应用程序cookie,SESSION_PERSISTENCE_TYPE_SOURCE_IP_COOKIE-源IP地址cookie,enableSessionPersistence生效时可用。协议为HTTP时,只能填SESSION_PERSISTENCE_TYPE_APPLICATION_COOKIE;协议为TCP或UDP时,只能填SESSION_PERSISTENCE_TYPE_SOURCE_IP_COOKIE | SESSION_PERSISTENCE_TYPE_APPLICATION_COOKIE | |
cookieName | 否 | String | cookie名称。sessionPersistenceType为SESSION_PERSISTENCE_TYPE_APPLICATION_COOKIE时填写。请确认Cookie名称和后端服务器所承载应用配置的Cookie名称一致 | my-test-cookie | |
description | 否 | String | 后端服务器组描述。 | my backend-group for ecx test | |
enableHealthCheck | 否 | Boolean | 是否启用健康检查。默认为false。 | false | |
healthCheckDomain | 否 | String | 健康检查域名。启用HTTP健康检查功能时需要填写。 | www.ctyun.ecxtest.com | |
healthCheckPort | 否 | String | 健康检查端口,开启检查时必填,不填默认使用后端服务器业务端口进行检查,除非您需要指定特定端口,否则建议留空. |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | Object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
slbBackendGroupId | 是 | String | 后端服务器组id | 22 |
6)请求示例
请求体body
{
"slbId": "3190",
"name": "slb-服务组-http",
"healthCheckDomain": "www.ctyun.ecxtest.com",
"protocol": "PROTOCOL_HTTP",
"description": "test",
"balancePolicy": "BALANCE_POLICY_ROUND_ROBIN",
"enableSessionPersistence": true,
"sessionPersistenceTimeout": 66,
"cookieName": "cookie-name-av6i",
"sessionPersistenceType": "SESSION_PERSISTENCE_TYPE_APPLICATION_COOKIE",
"enableHealthCheck": true
}
{
"slbId": "3190",
"name": "slb-服务组-tcp",
"protocol": "PROTOCOL_TCP",
"description": "test",
"balancePolicy": "BALANCE_POLICY_ROUND_ROBIN",
"enableSessionPersistence": true,
"sessionPersistenceTimeout": 30,
"sessionPersistenceType": "SESSION_PERSISTENCE_TYPE_SOURCE_IP_COOKIE",
"enableHealthCheck": true
}
{
"slbId": "3190",
"name": "slb-服务组-udp",
"protocol": "PROTOCOL_UDP",
"description": "test",
"balancePolicy": "BALANCE_POLICY_ROUND_ROBIN",
"enableSessionPersistence": true,
"sessionPersistenceTimeout": 30,
"sessionPersistenceType": "SESSION_PERSISTENCE_TYPE_SOURCE_IP_COOKIE",
"enableHealthCheck": true
}
7)响应示例
{
"status": {
"message": "Success",
"code": "Success"
},
"data": {
"slbBackendGroupId": "5311"
},
"requestId": "9b56d4cf-56a3-4ebe-95b6-eccc6dccdb6e"
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |