輕量型云主機新建云硬盤
更新時間 2025-02-02 09:48:14
最近更新時間: 2025-02-02 09:48:14
分享文章
輕量型云主機新建云硬盤
接口功能介紹
該接口提供用戶輕量型云主機新建云硬盤的能力
??1. 云硬盤購買完成后自動掛載至輕量型云主機
??2. 數據盤到期日與所掛載的實例一致
??3. 實例和數據盤必須一起續費,無法單獨為實例或數據盤續費
??4. 若數據盤所屬輕量型云主機已開啟自動續費,則數據盤默認開啟自動續費
??5. 云硬盤計費方式:包年包月
準備工作:
??構造請求:在調用前需要了解如何構造請求,詳情查看構造請求
??認證鑒權:openapi請求需要進行加密調用,詳細查看認證鑒權
??計費模式:確認開通云主機的計費模式及計費項,詳細查看計費方式及計費項
??產品選型:購買輕量型云主機前,請先閱讀實例套餐了解輕量型云主機的規格套餐,并通過接口,獲取當前資源池可用輕量型云主機規格信息
注意事項:
??成本估算:了解云主機的計費項,詳細查看價格總覽進行成本估算
??用戶配額:確認個人在不同資源池下資源配額,可以通過接口進行查詢
??異步接口:該接口為異步接口,下單成功不代表業務成功。
接口約束
??1. 確保當前請求資源池下,該輕量型云主機存在(即instanceID真實存在且與regionID相對應)
??2. 云主機需要處于運行中(running)或關機(stopped)狀態,您可以調用查詢結果中的instanceStatus字段來確認當前云主機狀態
URI
POST /v4/ecs/lite/create-volume
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| clientToken | 是 | String | 客戶端存根,用于保證訂單冪等性。要求單個云平臺賬戶內唯一,使用同一個ClientToken值,其他請求參數相同時,則代表為同一個請求。保留時間為24小時 | 4cf2962d-e92c-4c00-9181-cfbb2218636c | |
| regionID | 是 | String | 資源池ID,您可以查看地域和可用區來了解資源池 獲取: 查 |
bb9fdb42056f11eda1610242ac110002 | |
| instanceID | 是 | String | 輕量型云主機ID,您可以查看輕量型云主機了解輕量型云主機的相關信息 獲取: 查 創 |
adc614e0-e838-d73f-0618-a6d51d09070a | |
| diskName | 是 | String | 磁盤名稱,名稱規則:長度2~63,不支持中文。注:當創建多塊云硬盤時(即參數diskCount的值大于1時),第二塊盤起名稱會追加序號。 | vol-test | |
| diskType | 是 | String | 磁盤類型,取值范圍: SATA(普通IO), SAS(高IO), SSD(超高IO) 您可以查看磁盤類型及性能介紹磁盤類型相關信息 |
||
| diskSize | 是 | Integer | 磁盤容量,單位為GB,取值范圍:[10, 32768] | 20 | |
| diskCount | 否 | String | 本地訂購磁盤數量。注:不填寫默認為1塊盤,創建多塊盤時填寫多個;該參數值受單臺輕量型云主機掛載硬盤上限值限制。 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| 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
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| masterOrderID | String | 訂單ID。調用方在拿到masterOrderID之后,在若干錯誤情況下,可以使用materOrderID進一步確認訂單狀態及資源狀態 | 235145e4489811eda8330242ac110002 | |
| masterOrderNO | String | 訂單號 | 20221010142913884246 | |
| masterResourceID | String | 主資源ID | 3cda4bf48cac42b8b7db3b279d2fc6fb | |
| regionID | String | 資源所屬資源池ID | aaf589124d5d11eaa04d0242ac110002 |
請求示例
請求頭header
無
請求體body
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"clientToken": "lite-ecs-create-vol-test01",
"instanceID": "adc614e0-e838-d73f-0618-a6d51d09070a",
"diskType": "SATA",
"diskSize": 10,
"diskName": "att-test",
"diskCount": 2
}
響應示例
{
"returnObj": {
"regionID": "aaf589124d5d11eaa04d0242ac110002",
"masterOrderID": "107e901c449611ed8b6a0242ac110002",
"masterOrderNO": "20221009163836430197"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 表示請求成功。 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Openapi.PatternCheck.NotValid | 請求參數無效 |
| LiteEcs.Parameter.InvalidError | 請求參數錯誤 |
| LiteEcs.RegionVersion.NotSupport | 當前API不支持該資源池,請切換資源池重試 |
| LiteEcs.RegionInfo.Empty | 查詢資源池信息為空或資源池不存在,請確認資源池ID是否有效 |
| LiteEcs.RegionInfo.AccessFailed | 查詢資源池失敗,請重試。如果多次嘗試失敗,請提交工單 |
| LiteEcs.RegionInfo.DataDamaged | 查詢資源池信息不符預期,請重試。如果多次嘗試失敗,請提交工單 |
| Openapi.EcsCheck.UnknownError | 云主機檢查失敗,請重試。如果多次嘗試失敗,請提交工單 |
| LiteEcs.Instance.NotFound | 輕量型云主機不存在,請確認云主機ID是否有效 |
| LiteEcs.Instance.StatusNotValid | 云主機沒有處于['running', 'stopped']狀態之一,請再次確認云主機狀態 |
| Openapi.EbsCheck.NotSupported | 磁盤類型不支持 |
| Openapi.EbsCheck.QuotaExceed | 單個主機的磁盤個數超出系統限額 |
| LiteEcs.Instance.EbsSoldOut | 該規格磁盤已售罄,請提交工單 |
| Openapi.SaleCheck.UnknownError | 售罄信息檢查失敗,請重試。如果多次嘗試失敗,請提交工單 |
| LiteEcs.Order.AccessFailed | 訪問訂單系統失敗 |
| LiteEcs.Order.ProcFailed | 訂單處理失敗 |