查看后端主機組詳情
更新時間 2025-10-22 18:26:27
最近更新時間: 2025-10-22 18:26:27
分享文章
接口功能介紹
查看后端主機組信息
接口約束
無
URI
GET /v4/elb/show-target-group
路徑參數 無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 區域ID | 81f7728662dd11ec810800155d307d5b | |
| ID | 否 | String | 后端主機組ID, 該字段后續廢棄 | XXX | |
| targetGroupID | 是 | String | 后端主機組ID, 推薦使用該字段, 當同時使用 ID 和 targetGroupID 時，優先使用 targetGroupID | tg-vzedsj8s49 |
請求參數
請求頭header參數 無
請求體body參數 無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| 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 |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| regionID | String | 區域ID | 81f7728662dd11ec810800155d307d5b | |
| azName | String | 可用區名稱 | AZ1 | |
| projectID | String | 項目ID | 0 | |
| ID | String | 后端主機組ID | XXX | |
| name | String | 后端主機組名稱 | test | |
| description | String | 描述 | dec | |
| vpcID | String | vpc ID | vpc-xxx | |
| healthCheckID | String | 健康檢查ID | hc-xxx | |
| algorithm | String | 調度算法 | wrr | |
| sessionSticky | Object | 會話保持配置 | sessionSticky | |
| status | String | 狀態: DOWN / ACTIVE | DOWN | |
| createdTime | String | 創建時間，為UTC格式 | 2022-09-28T07:37:38Z | |
| updatedTime | String | 更新時間，為UTC格式 | 2022-09-28T07:37:38Z | |
| protocol | String | 協議類型 | TCP | |
| allPortForward | Integer | 全端口轉發開關 | 0 | |
| centerHealthCheckLoadBalancerId | String | 集中健康檢查所綁定的負載均衡ID | lb-xxxx | |
| connectionDrainEnabled | Integer | 優雅中斷功能開關 | 0 | |
| connectionDrainTimeout | String | 優雅中斷功能超時時間 | 300 | |
| proxyProtocol | Integer | 獲取客戶端真實源IP功能開關 | 0 | |
| 表 sessionSticky |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| sessionStickyMode | String | 會話保持模式，支持取值：CLOSE（關閉）、INSERT（插入）、REWRITE（重寫 | CLOSE | |
| cookieExpire | Integer | cookie過期時間 | 121 | |
| rewriteCookieName | String | cookie重寫名稱 | xxx | |
| sourceIpTimeout | Integer | 源IP會話保持超時時間。 | 1231 |
枚舉參數
無
請求示例
請求url
GET /openapi/v4/elb/show-target-group?regionID=81f7728662dd11ec810800155d307d5b&targetGroupID=tg-01bh5cr7gu
請求頭header
無
請求體body
無
響應示例
#### 成功響應示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": [
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"azName": null,
"projectID": "0",
"ID": "tg-td6uhtxhso",
"name": "yacos_test_target_group3",
"description": "yacos_test3",
"vpcID": "vpc-mv4gqflr2x",
"healthCheckID": "",
"algorithm": "lc",
"sessionSticky": {
"sessionStickyMode": "CLOSE",
"cookieExpire": 0,
"rewriteCookieName": "",
"sourceIpTimeout": 0
},
"status": "ACTIVE",
"createdTime": "2022-09-28T07:37:38Z",
"updatedTime": "2022-09-28T07:37:38Z"
}
]
}
#### 失敗響應示例
{
"statusCode": 900,
"message": "request param error",
"description": "參數錯誤",
"errorCode": "Openapi.Parameter.Error"
}
狀態碼
請參考
錯誤碼
請參考
