接口功能介绍
更新后端服务组。
接口约束
无。
URI
POST /v4/elb/update-target-group
请求参数
请求体body参数
参数 | 参数类型 | 是否必填 | 说明 | 示例 |
---|---|---|---|---|
clientToken | String | 否 | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一 | |
regionID | String | 是 | 区域ID | |
projectID | String | 否 | 企业项目ID,默认为"0" | 0 |
ID | String | 是 | 后端服务组ID | |
name | String | 否 | 后端服务组名称 | |
description | String | 否 | 描述 | |
healthCheckID | String | 否 | 健康检查ID | |
algorithm | String | 否 | 调度算法。取值范围:rr(轮询)、wrr(带权重轮询)、lc(最少连接)、sh(源IP哈希) | rr |
sessionSticky | Object | 否 | 会话保持配置 |
表 sessionSticky
参数 | 参数类型 | 是否必填 | 说明 | 示例 |
---|---|---|---|---|
sessionStictyMode | String | 是 | 会话保持模式,支持取值:CLOSE(关闭)、INSERT(插入)、REWRITE(重写)、SOURCE_IP(源IP) | CLOSE |
cookieExpire | Integer | 否 | cookie过期时间。INSERT模式必填 | |
rewriteCookieName | String | 否 | cookie重写名称,REWRITE模式必填 | |
sourceIpTimeout | Integer | 否 | 源IP会话保持超时时间。SOURCE_IP模式必填 |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 |
message | String | 错误信息的英文描述 | |
description | String | 返回信息说明,如果请求成功,返回空字符串;否则为错误信息。 | |
errCode | String | 错误描述 | |
returnObj | Object of Array | 接口业务数据 |
表 returnObj
参数 | 参数类型 | 说明 |
---|---|---|
ID | String | 后端服务组ID |
请求示例
POST /v4/elb/update-target-group
请求体body
{
"clientToken": "xxxx",
"regionID": "81f7728662dd11ec810800155d307d5b",
"ID": "tg-01bh5cr7gu",
"name": "yacos_test_update",
"description": "yacos_test_update",
"algorithm": "wr",
"sessionSticky": {
"sessionStickyMode": "SOURCE_IP",
"sourceIpTimeout": 10
},
"healthCheckID": ""
}
响应示例
{
"statusCode": 800,
"message": "success",
"description": "",
"errCode": "SUCCESS",
"returnObj": {
"ID": "tg-vzedsj8s49"
}
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
请参考 错误码说明。