更新后端主機組
更新時間 2025-10-22 18:26:35
最近更新時間: 2025-10-22 18:26:35
分享文章
接口功能介紹
更新后端主機組
接口約束
無
URI
POST /v4/elb/update-target-group
路徑參數 無
Query參數 無
請求參數
請求頭header參數 無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客戶端存根，用于保證訂單冪等性, 長度 1 - 64 | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 | |
| regionID | 是 | String | 區域ID | 81f7728662dd11ec810800155d307d5b | |
| projectID | 否 | String | 企業項目ID，默認為'0' | 0 | |
| ID | 否 | String | 后端主機組ID, 該字段后續廢棄 | xxxx | |
| targetGroupID | 是 | String | 后端主機組ID, 推薦使用該字段, 當同時使用 ID 和 targetGroupID 時，優先使用 targetGroupID | tg-vzedsj8s49 | |
| name | 否 | String | 唯一。支持拉丁字母、中文、數字，下劃線，連字符，中文 / 英文字母開頭，不能以 http: / https: 開頭，長度 2 - 32 | test | |
| description | 否 | String | 支持拉丁字母、中文、數字, 特殊字符：~!@#$%^&()_-+= <>?:'{},./;'[,]·！@#￥%……&（） —— -+={},《》？：“”【】、；‘'，。、，不能以 http: / https: 開頭，長度 0 - 128 | desc | |
| healthCheckID | 否 | String | 健康檢查ID | hc-xxx | |
| algorithm | 否 | String | 調度算法。取值范圍：rr（輪詢）、wrr（帶權重輪詢）、lc（最少連接）、sh（源IP哈希） | wrr | |
| proxyProtocol | 否 | Integer | 1 開啟，0 關閉 | 1 | |
| sessionSticky | 否 | Object | 會話保持配置 | sessionSticky | |
| protocol | 否 | String | 協議，支持 TCP / UDP / HTTP / HTTPS / GENEVE，暫不支持更新協議類型。 | TCP | |
| 表 sessionSticky |
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| sessionStickyMode | 是 | String | 會話保持模式，支持取值：CLOSE（關閉）、INSERT（插入）、REWRITE（重寫），當 algorithm 為 lc / sh 時，sessionStickyMode 必須為 CLOSE | CLOSE | |
| cookieExpire | 否 | Integer | cookie過期時間。INSERT模式必填 | 1 | |
| rewriteCookieName | 否 | String | cookie重寫名稱，REWRITE模式必填 | XXX | |
| sourceIpTimeout | 否 | Integer | 源IP會話保持超時時間。SOURCE_IP模式必填 | 10 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| 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 | Array of Objects | 接口業務數據 | returnObj | |
| 表 returnObj |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| ID | String | 后端主機組ID | target-49bp8uzydb |
枚舉參數
無
請求示例
請求url
POST /v4/elb/update-target-group
請求頭header
無
請求體body
{
"clientToken": "xxxx",
"regionID": "81f7728662dd11ec810800155d307d5b",
"targetGroupID": "tg-vzedsj8s49",
"name": "yacos_test_update",
"description": "yacos_test_update",
"algorithm": "wr",
"sessionSticky": {
"sessionStictyMode": "SOURCE_IP",
"sourceIpTimeout": 10
},
"healthCheckID": ""
}
響應示例
#### 成功響應示例
{
"statusCode": 800,
"message": "success",
"description": "成功",
"errorCode": "SUCCESS",
"returnObj": [
{
"ID": "tg-vzedsj8s49"
}
]
}
#### 失敗響應示例
{
"statusCode": 900,
"message": "request param error",
"description": "參數錯誤",
"errorCode": "Openapi.Parameter.Error"
}
狀態碼
請參考
錯誤碼
請參考
