查詢堡壘機列表
更新時間 2025-03-27 11:11:30
最近更新時間: 2025-03-27 11:11:30
分享文章
接口功能介紹
查詢租戶購買的堡壘機實例列表信息。
接口約束
天翼云用戶。
URI
POST /osm/v2/console/listInstance
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| pageNumber | 是 | Integer | 當前分頁 | 1 | |
| pageSize | 是 | Integer | 分頁顯示的數據條數 | 10 | |
| name | 否 | String | 主機名稱 | osm-82134 | |
| privateIp | 否 | String | 主機私網ip | 192.168.1.209 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| error | String | 接口錯誤詳情 | ||
| statusCode | String | 接口請求狀態碼 | 00000表示成功，其他為失敗 | |
| message | String | 請口操作結果說明 | 操作成功或失敗說明 | |
| page | Object | 分頁信息對像 | page | |
| returnObj | Array of Objects | 返回數據對像 | returnObj |
表 page
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| current | Integer | 當前頁碼 | 3 | |
| size | Integer | 分頁數據記錄數 | 10 | |
| total | Integer | 總數據量 | 54 |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| id | String | 堡壘機的唯一標識 | 700c065cbbd35b8aa07d551dba4a5141 | |
| instanceName | String | 堡壘機名稱 | osm-823gx | |
| regionId | String | 堡壘機所在資源池id | 貴州6公有云1 | |
| regionName | String | 堡壘機所在資源池名稱 | 8dd80525678b11edbc9e0242ac110002 | |
| azName | String | 堡壘機所在可用區 | cn-xinan1 | |
| vmStatus | String | 主機狀態 running：運行中 starting; 啟動中 backingup: 備份中 stopping: 執行關機中 stopped: 已關機 restarting: 重啟中 creating: 創建中 expired: 已到期 starting: 開機中 freezing: 凍結中 upgrading: 升級中 resizing: 變配中 error: 主機錯誤 | running | |
| eipId | String | 公網動態ip id | 8.43848E+11 | |
| eipAddress | String | 公網動態ip | 20.138.38.20 | |
| specName | String | 規格名稱 | 企業版 | |
| assetsNum | String | 授權資產數量 | 20 | |
| concurrencyNumber | Integer | 規格授權并發量 | 100 | |
| vpcId | String | vpc id | vpc077343 | |
| vpcName | String | vpc名稱 | vpc-osm | |
| securityGroupId | String | 安全組id | sg-1v5hv8r5ng | |
| securityGroupName | String | 安全組名稱 | sgs-osm | |
| subnetId | String | 子網id | subnet-6m1u7qpjp4 | |
| subnetName | String | 子網名稱 | subnet-osm | |
| cpuNum | Integer | 表示核心主機cpu數量 | 8 | |
| memSize | Integer | 表示內存大小，單位G | 16 | |
| vmHdType | String | 數據盤類型 | sata：高帶磁盤 | |
| vmHd | Integer | 數據盤大小,單位G | 300 | |
| vmHdUsed | Integer | 數據盤已使用量,單位G | 100 | |
| createTimee | String | 創建時間 | 2024/10/10 10:10 | |
| expireDate | String | 到期時間 | 2024/10/10 10:10 |
枚舉參數
無
請求示例
請求url
無
請求頭header
無
請求體body
{
"vmId": "osm-83489843893",
"pageNumber": 1,
"pageSize": 10,
"userName": "zhangsan",
"name": "張三",
"phone": "18509098345",
"status": "ACTIVE",
"startTime": "2024-09-14 10:11:40",
"endTime": "2024-10-14 10:11:40",
"userGroupId": "user-group-id"
}
響應示例
{
"statusCode": "0",
"message": "操作成功",
"page": {
"current": 3,
"size": 10,
"total": 54
},
"returnObj": [
{
"id": "8934429824389",
"userName": "zhangsan",
"name": "張三",
"email": "zhangsan@qq.com",
"status": "ACTIVE",
"expireTime": "2024-10-10 10:10:10",
"bindOtp": true,
"bindUsbKey": false,
"createBy": "admin",
"createTime": "2024-10-10 10:10:10",
"lastLogin": "2024-10-10 10:10:10"
}
]
}
狀態碼
請參考
錯誤碼
請參考
