1)接口功能介绍
更新后端服务器组。
2)接口约束
要注意熟悉接口请求的字段说明,字段的值存在相互关联,也可以参考请求例子的值。
3)URI
POST /v1/updateBackendGroup。
4)请求参数
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
slbBackendGroupId | 是 | String | 后端服务器组 id | 232 | |
name | 否 | String | 后端服务器组名称. 命名要求:大小写字母、数字或中划线(-)组成;大小写字母开头;数字或大小写字母结尾;长度不超过64。建议格式为:service-group-*** 。如果不填,sdk默认会生成该字段。 | my-test-backend-group | |
balancePolicy | 是 | String | 负载均衡策略,不填代表不修改原有策略.。启用会话保持功能时不能选择"BALANCE_POLICY_IP_HASH"策略。 BALANCE_POLICY_UNSPECIFIED: 未指定 , BALANCE_POLICY_ROUND_ROBIN: 轮询 , BALANCE_POLICY_IP_HASH: IP hash , BALANCE_POLICY_LEAST_CONNECT: 加权最少连接数 | BALANCE_POLICY_ROUND_ROBIN | |
sessionPersistence | 否 | String | 是否启用会话保持,不填代表不修改原有策略 。内网SLB的后端服务器组不能启用会话保持。 | SESSION_PERSISTENCE_DISABLE | |
sessionPersistenceTimeout | 否 | Integer | 会话保持时间 | 60 | 要求取值范围为1~60,默认值5,单位:分钟。 |
sessionPersistenceType | 否 | String | 会话保持类型,不填代表不修改已有会话保持类型 。目前protocol为HTTP时只支持“SESSION_PERSISTENCE_TYPE_APPLICATION_COOKIE”,protocol为TCP或UDP时只支持“SESSION_PERSISTENCE_TYPE_SOURCE_IP_COOKIE”。 | SESSION_PERSISTENCE_TYPE_APPLICATION_COOKIE | |
cookieName | 否 | String | cookie名称 .启用cookie会话保持功能时需要填写。请确认Cookie名称和后端服务器所承载应用配置的Cookie名称一致 | my-test-cookie | |
healthCheck | 否 | String | 是否启用健康检查,不填代表不修改原有配置 . 启用HTTP健康检查功能时需要填写。 | HEALTH_CHECK_DISABLE | |
healthCheckDomain | 否 | String | 健康检查域名 | www.ctyun.ecxtest.com | |
healthCheckPort | 否 | String | 健康检查端口,开启检查时必填,为0则默认使用业务端口进行检查 | 80 | |
description | 否 | String | 后端服务器组描述。最大长度255字节 | my backend-group for ecx test |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
6)请求示例
请求体body
{
"slbBackendGroupId": "12",
"balancePolicy": "BALANCE_POLICY_UNSPECIFIED",
"cookieName": "test",
"description": "test",
"healthCheck": "HEALTH_CHECK_UNSPECIFIED",
"healthCheckDomain": "",
"healthCheckPayload": "",
"healthCheckPort": 66,
"name": "my-test-backend-group",
"sessionPersistence": "SESSION_PERSISTENCE_UNSPECIFIED",
"sessionPersistenceTimeout": 56744854,
"sessionPersistenceType": "SESSION_PERSISTENCE_TYPE_UNSPECIFIED"
}
7)响应示例
{
"requestId": "c37c3741-1f96-436d-abf9-f1c4aa361007",
"status": {
"code": "Success",
"message": "Success"
}
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |