负载均衡策略配置
接口功能介绍
接口约束
无
URI
/cgw/v1/upstream/updateBalancerConfig
请求方式: POST
Content-Type: application/json
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池编码 | 7a2828074ef6e32e041a2ef124b19e63 |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
id | 是 | String | 服务内部id | 7a2828074ef6e32e041a2ef124123456 | |
instId | 是 | String | 实例id | 123456074ef6e32e041a2ef124123456 | |
balancerStrategy | 是 | Object | 服务负载均衡策略配置 | BalancerStrategy |
表 BalancerStrategy
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
balancerType | 否 | String | 服务负载均衡策略,roundrobin、chash、ewma、least_conn,默认值为roundrobin | roundrobin | |
hashOn | 否 | String | 哈希位置,支持的类型有 vars(Nginx 内置变量),header(自定义 header),cookie,consumer,默认值为 vars | vars | |
key | 否 | String | key,负载均衡类型为chash时,必填。可配置项有:uri, server_name, server_addr, request_uri, remote_port, remote_addr, query_String, host, hostname | uri |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 接口状态码 | 2000 | |
code | String | 错误码,异常时非空 | CGW_1001 | |
returnObj | Object | 返回数据 | {} | |
message | String | 异常描述 | success |
请求示例
请求url
https://127.0.0.1:8080/cgw/v1/upstream/updateBalancerConfig
请求头header
{
"regionId": "1234567890"
}
请求体body
{
"id": "00000000000000000050",
" balancerStrategy ": {
" balancerType ": " roundrobin "
},
" instId ": " 878da73f7dba36ff0ae80e004a4f28f9 "
}
响应示例
{
"message": "String",
"returnObj": {},
"statusCode": 2000
}
状态码
请参考 状态码说明。
错误码
请参考 错误码说明。