查看負載均衡實例詳情
更新時間 2025-10-22 18:26:05
最近更新時間: 2025-10-22 18:26:05
分享文章
接口功能介紹
查看負載均衡實例
接口約束
無
URI
GET /v4/elb/show-loadbalancer
路徑參數 無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 區域ID | 81f7728662dd11ec810800155d307d5b | |
| ID | 否 | String | 負載均衡ID, 該字段后續廢棄 | xxx | |
| elbID | 是 | String | 負載均衡ID, 推薦使用該字段 | lb-xxx |
請求參數
請求頭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 | |
| ID | String | 負載均衡ID | xxx | |
| projectID | String | 項目ID | 0 | |
| name | String | 名稱 | test | |
| description | String | 描述 | desc | |
| vpcID | String | VPC ID | vpc-xxx | |
| subnetID | String | 子網ID | subnet-xxx | |
| portID | String | 負載均衡實例默認創建port ID | port-xxx | |
| privateIpAddress | String | 負載均衡實例的內網VIP | 32.33.433.5 | |
| ipv6Address | String | 負載均衡實例的IPv6地址 | 2001:db8:85a3::8a2e:370:7334 | |
| slaName | String | 規格名稱 | elb.default | |
| eipInfo | Array of Objects | 彈性公網IP信息 | eipInfo | |
| deleteProtection | Boolean | 刪除保護。開啟，不開啟 | true | |
| adminStatus | String | 管理狀態: DOWN / ACTIVE | DOWN | |
| status | String | 負載均衡狀態: DOWN / ACTIVE | DOWN | |
| resourceType | String | 負載均衡類型: external / internal | internal | |
| createdTime | String | 創建時間，為UTC格式 | 2022-10-03T09: 44: 22Z | |
| updatedTime | String | 更新時間，為UTC格式 | 2022-10-03T09: 44: 22Z | |
| billingMethod | String | 計費方式 | periodic | |
| 表 eipInfo |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| resourceID | String | 計費類資源ID | xxx | |
| eipID | String | 彈性公網IP的ID | eip-xxx | |
| bandwidth | Integer | 彈性公網IP的帶寬 | 1 | |
| isTalkOrder | Boolean | 是否按需資源 | true | |
| eipAddress | String | 彈性公網IP的地址 | 100.124.1.40 |
枚舉參數
無
請求示例
請求url
GET /v4/elb/show-loadbalancer?regionID=81f7728662dd11ec810800155d307d5b&ID=lb-xxx
請求頭header
無
請求體body
無
響應示例
#### 成功響應示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": [
{
"regionID": "73f321ea-62ff-11ec-a8bc-005056898fe0",
"azName": null,
"projectID": "0",
"ID": "lb-ai7x5ulq4t",
"name": "yacos_lb_test_ipv4",
"description": "yacos_lb_test_ipv4",
"vpcID": "vpc-krd9nz9wsc",
"subnetID": "subnet-mr9j7i1rnr",
"portID": "port-t6gm5lbphw",
"privateIpAddress": "10.0.0.20",
"ipv6Address": "",
"billingMethod": "periodic",
"eipInfo": [
{
"resourceID": "04be13e8826046d4ab20d233a5e2c349",
"eipID": "eip-poxi4vls1v",
"eipAddress": "100.124.1.40",
"bandwidth": 100,
"isTalkOrder": false
}
],
"slaName": "elb.s1.small",
"deleteProtection": false,
"adminStatus": "ACTIVE",
"status": "ACTIVE",
"resourceType": "external",
"createdTime": "2022-09-28T07: 27: 31Z",
"updatedTime": "2022-09-28T07: 27: 31Z"
}
]
}
#### 失敗響應示例
{
"statusCode": 900,
"message": "request param error",
"description": "參數錯誤",
"errorCode": "Openapi.Parameter.Error"
}
狀態碼
請參考
錯誤碼
請參考
