gwlb更新target_group
更新时间 2025-12-26 09:28:48
最近更新时间: 2025-12-26 09:28:48
接口功能介绍
更新target_group
接口约束
无
URI
POST /v4/gwlb/update-target-group
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池 ID | bb9fdb42056f11eda1610242ac110002 | |
| targetGroupID | 是 | String | 后端服务组 ID | tg-xxx | |
| name | 否 | String | 支持拉丁字母、中文、数字,下划线,连字符,中文 / 英文字母开头,不能以 http: / https: 开头,长度 2 - 32 | test | |
| description | 否 | String | 支持拉丁字母、中文、数字, 特殊字符:~!@#$%^&()_-+= <>?:"{},./;'[]·!@#¥%……&() —— -+={}《》?:“”【】、;‘',。、,不能以 http: / https: 开头,长度 0 - 128 | desc | |
| healthCheckID | 否 | String | 健康检查 ID,传空字符串时表示后端服务关闭健康检查 | hc-xxxx | |
| sessionStickyMode | 否 | Integer | 流保持类型,0:五元组, 4:二元组, 5:三元组 | 0 | |
| failoverType | 否 | Integer | 故障转移类型 1 表示关闭,2 表示再平衡 | 1 | |
| bypassType | 否 | Integer | 旁路类型 1 表示关闭,2 表示自动 | 1 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
| message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success | |
| description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 | |
| errorCode | String | statusCode为900时为业务细分错误码,三段式:product.module.code; statusCode为800时为SUCCESS | SUCCESS | |
| returnObj | Object | 接口业务数据 | returnObj | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| targetGroupID | String | 后端服务组ID | tg-xxxx |
枚举参数
无
请求示例
请求url
POST /openapi/v4/gwlb/update-target-group
请求头header
无
请求体body
{
"regionID": "xxxx",
"targetGroupID": "tg-xxxx"
}
响应示例
#### 成功响应示例
{
"statusCode":800,
"errorCode":"SUCCESS",
"message":"success",
"descritption": "成功",
"returnObj":{
"targetGroupID": "tg-xxx"
}
}
#### 失败响应示例
{
"statusCode": 900,
"message": "request param error",
"description": "参数错误",
"errorCode": "Openapi.Parameter.Error"
}
状态码
请参考 状态码
错误码
请参考 错误码