創建輕量型云主機
更新時間 2025-02-02 09:46:15
最近更新時間: 2025-02-02 09:46:15
分享文章
創建輕量型云主機
接口功能介紹
該接口提供用戶創建一臺包年包月的輕量型云主機
URI
POST /v4/ecs/lite/create
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| clientToken | 是 | String | 客戶端存根，用于保證訂單冪等性。要求單個云平臺賬戶內唯一，使用同一個ClientToken值，其他請求參數相同時，則代表為同一個請求。保留時間為24小時 | 4cf2962d-e92c-4c00-9181-cfbb2218636c | |
| regionID | 是 | String | 資源池ID，您可以調用查看最新的天翼云資源池列表 | 100054c0416811e9a6690242ac110002 | |
| displayName | 是 | String | 云主機顯示名稱，長度為2-15字符 | ecm-3300 | |
| flavorSetType | 是 | String | 規格套餐類型，取值范圍：fix：固定套餐band：帶寬套餐 | fix | |
| flavorName | 是 | String | 規格套餐名稱 | lite1.fix.small.1 | |
| imageID | 是 | String | 鏡像ID | 9d9e8998-8ed5-43b2-99cb-322f2b8cf6fa | |
| cycleCount | 是 | Integer | 訂購時長 | 6 | |
| cycleType | 是 | String | 本參數表示訂購周期類型 ，取值范圍：MONTH：按月YEAR：按年最長訂購周期為5年 | MONTH | |
| bootDiskSize | 否 | Integer | 帶寬套餐時填寫，系統盤大小單位為GiB，您可以調用[查詢輕量型云主機規格資源]獲取套餐系統盤取值范圍 | 40 | |
| bandwidth | 否 | Integer | 帶寬套餐時填寫，帶寬大小單位為Mbit/s ，您可以調用[查詢輕量型云主機規格資源]獲取套餐帶寬取值范圍 | 5 | |
| dataDiskList | 否 | Array of Objects | 數據盤 | disks | |
| userPassword | 否 | String | 用戶密碼，滿足以下規則：長度在8～30個字符;必須包含大寫字母、小寫字母、數字以及特殊符號中的三項;特殊符號可選：()`~!@#$%^&*_-+=\｜{}[]:;'<>,.?/ 且不能以斜線號/開頭 | 1qaz@WSX | |
| autoRenewStatus | 否 | Integer | 本參數表示是否自動續訂 ，取值范圍：0：不續費1：自動續費按月購買：自動續訂周期為1個月;按年購買：自動續訂周期為1年 | 1 |
表 disks
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| diskType | 是 | String | 云硬盤類型，取值范圍： SATA（普通IO）， SAS（高IO）， SSD（超高IO）， FAST-SSD（極速型SSD） 您可以查看磁盤類型及性能介紹磁盤類型相關信息 |
SATA | |
| diskSize | 是 | Integer | 磁盤容量大小單位為GiB，取值范圍[10-32768] | 50 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼(800為成功，900為失敗) | 800 | |
| errorCode | 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 | 81f7728662dd11ec810800155d307d5b |
請求示例
請求頭header
無
請求體body
{
"regionID":"bb9fdb42056f11eda1610242ac110002",
"clientToken":"create-fix-lite-vm-0711-01",
"azName":"cn-huadong1-jsnj1A-public-ctcloud",
"displayName":"openapi-fix-01",
"flavorSetType":"fix",
"flavorName":"lite1.fix.medium.2",
"imageID":"dca942b0-e934-4bd5-b5c1-4f5e1aad56a6",
"cycleCount":2,
"cycleType":"MONTH",
"autoRenewStatus":0,
"userPassword":"1qaz@WSX",
"dataDiskList":[
{
"diskType":"SAS",
"diskSize":20
}
]
}
響應示例
{
"returnObj": {
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "107e901c449611ed8b6a0242ac110002",
"masterResourceID": "34c7cc05a52b48eda0a84e34a82b346b",
"masterOrderNO": "20221009163836430197"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 表示請求成功。 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Openapi.PatternCheck.NotValid | 請求參數無效 |
| LiteEcs.Parameter.InvalidError | 請求參數錯誤 |
| LiteEcs.RegionInfo.Empty | 查詢資源池信息為空或資源池不存在，請確認資源池ID是否有效 |
| LiteEcs.RegionInfo.AccessFailed | 查詢資源池失敗，請重試。如果多次嘗試失敗，請提交工單 |
| LiteEcs.RegionInfo.DataDamaged | 查詢資源池信息不符預期，請重試。如果多次嘗試失敗，請提交工單 |
| LiteEcs.RegionVersion.NotSupport | 當前API不支持該資源池，請切換資源池重試 |
| LiteEcs.UserVisibleRegions.DataDamaged | 查詢用戶可見資源池信息格式錯誤，請重試。如果多次嘗試失敗，請提交工單 |
| LiteEcs.UserVisibleRegions.AccessFailed | 查詢用戶可見資源池失敗，請重試。如果多次嘗試失敗，請提交工單 |
| LiteEcs.Parameter.InvalidRegionID | 可見資源池信息為空，請確認regionID是否正確 |
| Openapi.CustomerAdmin.AccessFailed | 查詢用戶信息錯誤，請重試。如果多次嘗試失敗，請提交工單 |
| Openapi.CustomerAdmin.FormatError | 查詢用戶信息格式錯誤，請重試。如果多次嘗試失敗，請提交工單 |
| Openapi.CustomerCheck.UnknownError | 查詢用戶信息失敗，請重試。如果多次嘗試失敗，請提交工單 |
| LiteEcs.UserQuota.AccessFailed | 查詢用戶配額信息失敗，請重試。如果多次嘗試失敗，請提交工單 |
| LiteEcs.UserQuota.Empty | 查詢用戶配額信息為空，請重試。如果多次嘗試失敗，請提交工單 |
| LiteEcs.UserQuota.DataDamaged | 查詢用戶配額信息不符預期，請重試。如果多次嘗試失敗，請提交工單 |
| Openapi.PermissionAdmin.AccessFailed | 查詢用戶許可信息錯誤，請重試。如果多次嘗試失敗，請提交工單 |
| Openapi.PermissionAdmin.FormatError | 查詢用戶資源池許可信息錯誤，請重試。如果多次嘗試失敗，請提交工單 |
| Openapi.PermissionCheck.UnknownError | 查詢用戶許可信息失敗，請重試。如果多次嘗試失敗，請提交工單 |
| LiteEcs.Instance.ParameterInvalid | 請求參數錯誤 |
| LiteEcs.Instance.FlavorNotFound | 未找到對應的云主機規格，請確認輸入的云主機規格信息是否有效 |
| Openapi.FlavorAdmin.AccessFailed | 查詢云主機規格失敗，請重試。如果多次嘗試失敗，請提交工單 |
| Openapi.FlavorAdmin.FormatError | 查詢云主機規格信息格式錯誤，請重試。如果多次嘗試失敗，請提交工單 |
| Openapi.EcsWorkorder.AccessFailed | 查詢云主機失敗，請重試。如果多次嘗試失敗，請提交工單 |
| Openapi.EcsFormat.FormatError | 查詢云主機信息格式錯誤，請重試。如果多次嘗試失敗，請提交工單 |
| LiteEcs.Instance.QuotaExceed | 超出系統限額 |
| LiteEcs.Instance.QuotaUnknownError | 配額檢查失敗，請重試。如果多次嘗試失敗，請提交工單 |
| LiteEcs.UserPermission.AccessFailed | 查詢用戶權限失敗，請重試。如果多次嘗試失敗，請提交工單 |
| LiteEcs.UserPermission.Empty | 查詢用戶權限信息為空，請重試。如果多次嘗試失敗，請提交工單 |
| LiteEcs.UserDetail.AccessFailed | 查詢用戶詳情信息失敗，請重試。如果多次嘗試失敗，請提交工單 |
| LiteEcs.UserDetail.Empty | 查詢用戶詳情信息為空，請重試。如果多次嘗試失敗，請提交工單 |
| LiteEcs.UserDetail.DataDamaged | 查詢用戶詳情信息不符預期，請重試。如果多次嘗試失敗，請提交工單 |
| Image.ImageFormat.FormatError | 查詢鏡像信息格式錯誤，請重試。如果多次嘗試失敗，請提交工單 |
| Image.ImageAdmin.AccessFailed | 查詢鏡像信息錯誤，請重試。如果多次嘗試失敗，請提交工單 |
| Image.ImageWorkorder.AccessFailed | 查詢鏡像信息錯誤，請重試。如果多次嘗試失敗，請提交工單 |
| Image.ImageCheck.NotFound | 鏡像不存在或不符合要求，請確認鏡像信息是否正確 |
| Image.ImageCheck.UnknownError | 查詢鏡像信息失敗，請重試。如果多次嘗試失敗，請提交工單 |
| Openapi.SaleYacos.AccessFailed | 查詢售罄信息錯誤，請重試。如果多次嘗試失敗，請提交工單 |
| Openapi.SaleFormats.FormatError | 查詢售罄信息格式錯誤，請重試。如果多次嘗試失敗，請提交工單 |
| LiteEcs.Instance.FlavorSoldOut | 該規格云主機已售罄，請提交工單 |
| LiteEcs.Instance.EbsSoldOut | 該規格磁盤已售罄，請提交工單 |
| Openapi.SaleCheck.UnknownError | 售罄信息檢查失敗，請重試。如果多次嘗試失敗，請提交工單 |
| LiteEcs.Order.AccessFailed | 訪問訂單系統失敗 |
