更新后端主機組配置
更新時間 2025-05-23 22:34:38
最近更新時間: 2025-05-23 22:34:38
分享文章
接口功能介紹
更新后端服務組
接口約束
無
URI
POST /v4/elb/update-vm-pool
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 區域ID | ||
| targetGroupID | 是 | String | 后端服務組ID | ||
| name | 否 | String | 唯一。支持拉丁字母、中文、數字，下劃線，連字符，中文 / 英文字母開頭，不能以 http: / https: 開頭，長度 2 - 32 | acl11 | |
| healthCheck | 否 | Array of Objects | 當后端組已經有健康配置時，如果更新不傳健康配置信息，表示移除當前后端組的健康檢查配置 | healthCheck | |
| sessionSticky | 否 | Array of Objects | 當后端組已經有會話配置時，如果更新不傳會話配置信息，表示移除當前后端組的會話配置 | sessionSticky |
表 healthCheck
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| protocol | 是 | String | 健康檢查協議。取值范圍：TCP、UDP、HTTP | ||
| timeout | 是 | Integer | 健康檢查響應的最大超時時間，取值范圍：2-60秒,默認2秒 | 2 | |
| interval | 是 | Integer | 負載均衡進行健康檢查的時間間隔，取值范圍：1-20940秒，默認5秒 | 5 | |
| maxRetry | 是 | Integer | 最大重試次數，取值范圍：1-10次，默認2次 | 2 | |
| httpMethod | 否 | String | 僅當protocol為HTTP時必填且生效,HTTP請求的方法默認GET，{GET/HEAD} | ||
| httpUrlPath | 否 | String | 僅當protocol為HTTP時必填且生效,支持的最大字符長度：80 | / | |
| httpExpectedCodes | 否 | String | 僅當protocol為HTTP時必填且生效，最長支持64個字符，只能是三位數，可以以,分隔表示多個，或者以-分割表示范圍，默認200 | 200 |
表 sessionSticky
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| cookieName | 否 | String | cookie名稱 | test | |
| persistenceTimeout | 否 | Integer | 會話過期時間，1-86400 | 10000 | |
| sessionType | 是 | String | 會話保持類型。取值范圍：APP_COOKIE、HTTP_COOKIE、SOURCE_IP | APP_COOKIE |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| 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 | |
| error | String | statusCode為900時為業務細分錯誤碼，三段式：product.module.code; statusCode為800時為SUCCESS |
枚舉參數
無
請求示例
請求url
POST /v4/elb/update-vm-pool
請求頭header
無
請求體body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"targetGroupID": "tg-01bh5cr7gu",
"name": "yacos_test_update",
"healthCheck": {
"timeout": 3,
"interval": 5,
"maxRetry": 2,
"protocol": "TCP"
}
}
響應示例
{
"statusCode": 800,
"message": "success",
"description": "成功",
"errorCode": "SUCCESS"
}
狀態碼
請參考
錯誤碼
請參考
