查詢可用于專屬云的宿主機列表
更新時間 2025-04-02 10:01:32
最近更新時間: 2025-04-02 10:01:32
分享文章
接口功能介紹
該接口可供用戶查詢當前環境下，用戶所屬的專屬云下還可以加入的宿主機的信息列表
準備工作：
??構造請求：在調用前需要了解如何構造請求，詳情查看
??認證鑒權：openapi請求需要進行加密調用，詳細查看
接口約束
無
URI
GET /v4/dec/host/list-available-host
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID，您可以查看地域和可用區來了解資源池 獲取： 查 |
bb9fdb42056f11eda1610242ac110002 | |
| azName | 否 | String | 可用區名稱，您可以查看地域和可用區來了解可用區 獲取： 查 注：查詢結果中zoneList內返回存在可用區名稱(即多可用區，本字段填寫實際可用區名稱)，若查詢結果中zoneList為空（即為單可用區，本字段填寫default） |
cn-huadong1-jsnj1A-public-ctcloud |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| 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 |
表 results
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| azName | String | 展示給用戶的可用區自定義名稱（一般為空） | az2 | |
| decHostType | String | 宿主機類型，取值范圍：s2、c6、s6、s7、c7、s3、c3，類型會隨著專屬云能力進行增加 | cm6_optimized | |
| decHostName | String | 宿主機名稱 | cn-nm-region1-az2-compute-10e8e92e46 |
枚舉參數
無
請求示例
請求url
示例：查詢可用于專屬云的宿主機列表
GET '.../v4/dec/host/list-available-host?regionID=bb9fdb42056f11eda1610242ac110002&azName=cn-huadong1-jsnj3A-public-ctcloud'
請求頭header
無
請求體body
無
響應示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"results": [
{
"azName": "",
"decHostType": "cm6_optimized",
"decHostName": "cn-nm-region1-az2-compute-10e8e92e46"
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
狀態碼
請參考
錯誤碼
請參考
