查詢專屬宿主機列表
更新時間 2025-04-02 09:59:50
最近更新時間: 2025-04-02 09:59:50
分享文章
接口功能介紹
該接口供用戶查詢其所屬專屬宿主機列表功能，用戶可以根據此接口的返回值得到多臺宿主機信息
準備工作：
??構造請求：在調用前需要了解如何構造請求，詳情查看
??認證鑒權：openapi請求需要進行加密調用，詳細查看
注意事項：
??分頁查詢：當前查詢結果以分頁形式進行展示，單次查詢最多顯示50條數據
??匹配查找：可以通過部分字段進行匹配篩選數據，無符合條件的為空
接口約束
無
URI
POST /v4/dec/host/list-host
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID，您可以查看地域和可用區來了解資源池 獲取： 查 |
bb9fdb42056f11eda1610242ac110002 | |
| azName | 否 | String | 可用區名稱，您可以查看地域和可用區來了解可用區 獲取： 查 注：查詢結果中zoneList內返回存在可用區名稱(即多可用區，本字段填寫實際可用區名稱)，若查詢結果中zoneList為空（即為單可用區，本字段填寫default） |
cn-huadong1-jsnj1A-public-ctcloud | |
| pageNo | 否 | Integer | 頁碼，取值范圍：正整數（≥1），注：默認值為1 | 1 | |
| pageSize | 否 | Integer | 每頁記錄數目，取值范圍：[1, 50]，注：默認值為10 | 10 | |
| keyword | 否 | String | 關鍵字，對部分參數進行模糊查詢，包含：輸入宿主機id、name信息 | name-x |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗） | 800 | |
| errorCode | String | 錯誤碼，為product.module.code三段式碼 | Openapi.PatternCheck.NotValid | |
| error | String | 錯誤碼，為product.module.code三段式碼 | Openapi.PatternCheck.NotValid | |
| message | String | 英文描述信息 | SUCCESS | |
| description | String | 中文描述信息 | 成功 | |
| returnObj | Object | 成功時返回的數據 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| currentCount | Integer | 當前頁記錄數目 | 1 | |
| totalCount | Integer | 總記錄數 | 1 | |
| totalPage | Integer | 總頁數 | 1 | |
| results | Array of Objects | 分頁明細 | results |
表 results
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| decHostStatus | String | 宿主機狀態 | up | |
| decHostName | String | 展示給用戶的宿主機名稱 | host-01 | |
| cpuRatio | Float | CPU的倍頻 | 1 | |
| totalVMs | Integer | 總的虛機數量 | 2 | |
| usedVCPUs | Integer | 已用vCPU的數量 | 3 | |
| usedMemSize | Integer | 已用內存大小，單位MB | 154618822656 | |
| totalMemSize | Integer | 總內存大小，單位MB | 539182649344 | |
| totalVCPUs | Object | 總CPU數量 | ||
| autoDeployed | Boolean | 是否自動部署： True ：自動部署， False ：非自動部署 |
true | |
| runningVMs | Integer | 運行中的云主機數量 | 2 | |
| decHostID | String | 宿主機UUID | 417cdb4b-de54-e5e5-62da-b78533a45b38 | |
| cpuInfo | Object | cpu信息 | cpuInfo | |
| azName | String | 可用區名稱 | cn-huadong1-jsnj1A-public-ctcloud |
表 cpuInfo
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| vendor | String | 制造商 | intel | |
| model | String | CPU模式 | ||
| arch | String | 架構 | x86 | |
| featureList | Array of Strings | CPU特性，比如["pku","rtm"]等 | ||
| topology | Object | cpu拓撲結構 | topology |
表 topology
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| cores | Integer | 核數 | 16 | |
| cells | Integer | cell數 | 2 | |
| threads | Integer | 線程數 | 2 | |
| sockets | Integer | 套接字數 | 2 |
枚舉參數
無
請求示例
請求url
無
請求頭header
無
請求體body
示例1：指定每頁記錄數目，查詢指定頁宿主機信息
專屬云內指定每頁記錄數目為3，查看第2頁宿主機信息
{
"regionID": "a39b0db2989140c79e6de8c21d50f132",
"pageNo": 2,
"pageSize": 3
}
示例2：在多可用區類型資源池，查看單個可用區下的宿主機信息
專屬云內指定每頁記錄數目為5，查看第3頁的宿主機信息
{
"regionID": "a39b0db2989140c79e6de8c21d50f132",
"azName": "cn-huadong1-jsnj3A-public-ctcloud",
"pageNo": 3,
"pageSize": 5
}
示例3：指定關鍵字查找
專屬云內查詢關鍵字為test的云主機信息
{
"regionID": "a39b0db2989140c79e6de8c21d50f132",
"keyword": "test"
}
響應示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"results": [
{
"decHostStatus": "up",
"decHostName": "DDC-0001",
"cpuRatio": 1,
"totalVMs": 2,
"usedVCPUs": 2,
"usedMemSize": 2048,
"totalMemSize": 514204,
"totalVCPUs": 64,
"autoDeployed": true,
"runningVMs": 1,
"decHostID": "197ffc44-eff9-be52-a5db-00df24acddec",
"cpuInfo": {
"vendor": null,
"model": null,
"arch": null,
"featureList": null,
"topology": {
"cores": 16,
"cells": null,
"threads": 2,
"sockets": null
}
},
"azName": "cn-huadong1-jsnj1A-public-ctcloud"
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
狀態碼
請參考
錯誤碼
請參考
