接口功能介紹
本接口提供用戶在專屬云中創建一臺按量付費的云主機的功能
準備工作:
??構造請求:在調用前需要了解如何構造請求,詳情查看
??認證鑒權:openapi請求需要進行加密調用,詳細查看
??計費模式:確認開通云主機的計費模式,詳細查看計費模式
??地域選擇:選擇要創建云主機的專屬云的資源池
??產品選型:購買彈性云主機前,請先閱讀規格說明了解彈性云主機的選型基本信息,并通過接口,獲取當前資源池可用云主機規格信息
??網絡規劃:規劃云主機的網絡環境,詳細查看彈性云主機-網絡
注意事項:
??成本估算:了解云主機的計費項
??用戶配額:確認個人在不同資源池下資源配額,可以通過接口進行查詢
??異步接口:該接口為異步接口,下單過后會拿到主訂單ID(masterOrderID),后續可以調用,使用主訂單ID來對訂單情況與開通成功后的資源ID進行查詢
??單臺創建:當前接口只能創建單臺云主機
??監控安裝:在云服務器創建成功后,3-5分鐘內將完成詳細監控Agent安裝,即開啟云服務器CPU,內存,網絡,磁盤,進程等指標詳細監控,若不開啟,則無任何監控數據
接口約束
??1. 專屬云內創建云主機均為按需類型云主機
??2. 自動分配彈性IP(extIP="1")時,需要填寫彈性IP版本(ipVersion)與帶寬大小(bandwidth);使用已有的彈性IP(extIP="2")時,需要填寫彈性IP的版本(ipVersion)和對應彈性IP的ID(eipID或ipv6AddressID)
??3. 掛載網卡時,子網與虛擬私有云存在對應關系,確保子網屬于當前虛擬私有云
URI
POST /v4/dec/create-instance
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| clientToken | 是 | String | 客戶端存根,用于保證訂單冪等性。要求單個云平臺賬戶內唯一,使用同一個clientToken值,其他請求參數相同時,則代表為同一個請求。保留時間為24小時 | 4cf2962d-e92c-4c00-9181-cfbb2218636c | |
| regionID | 是 | String | 資源池ID,您可以查看地域和可用區來了解資源池 獲取: 查 |
bb9fdb42056f11eda1610242ac110002 | |
| azName | 是 | String | 可用區名稱,您可以查看地域和可用區來了解可用區 獲取: 查 注:查詢結果中zoneList內返回存在可用區名稱(即多可用區,本字段填寫實際可用區名稱),若查詢結果中zoneList為空(即為單可用區,本字段填寫default) |
cn-huadong1-jsnj1A-public-ctcloud | |
| instanceName | 是 | String | 云主機名稱。不同操作系統下,云主機名稱規則有差異 Windows:長度為2-15個字符,允許使用大小寫字母、數字或連字符(-)。不能以連字符(-)開頭或結尾,不能連續使用連字符(-),也不能僅使用數字; 其他操作系統:長度為2-64字符,允許使用點(.)分隔字符成多段,每段允許使用大小寫字母、數字或連字符(-),但不能連續使用點號(.)或連字符(-),不能以點號(.)或連字符(-)開頭或結尾,也不能僅使用數字 |
ecm-3300 | |
| displayName | 是 | String | 云主機顯示名稱,長度為2~63字符 | ecm-3300 | |
| flavorID | 是 | String | 云主機規格ID,您可以查看規格說明了解彈性云主機的選型基本信息 獲取: 查 注:同一規格名稱在不同資源池不同可用區的規格ID是不同的,調用前需確認規格ID是否歸屬當前資源池,多可用區資源池確認是否歸屬當前可用區 |
0824679a-dc86-47dc-a0d3-9c330928f4f6 | |
| decHostID | 否 | String | 專屬宿主機ID,獲取: 查 |
73f321ea-62ff-11ec-a8bc-005056898fe0 | |
| decTypeID | 否 | String | 專屬云存儲ID | 32af90b5-664c-41c4-bc59-0f88b39eebc2 | |
| imageType | 是 | Integer | 鏡像類型,取值范圍: 0:私有鏡像, 1:公有鏡像, 2:共享鏡像, 3:安全鏡像, 4:甄選鏡像 您可以查看鏡像概述查看關于云主機鏡像介紹 |
1 | |
| imageID | 是 | String | 鏡像ID,您可以查看鏡像概述來了解云主機鏡像 獲取: 查 創 創 注:同一鏡像名稱在不同資源池的鏡像ID是不同的,調用前需確認鏡像ID是否歸屬當前資源池 |
9d9e8998-8ed5-43b2-99cb-322f2b8cf6fa | |
| bootDiskType | 是 | String | 系統盤類型,取值范圍: SATA:普通IO, SAS:高IO, SSD:超高IO, FAST-SSD:極速型SSD 您可以查看磁盤類型及性能介紹來了解磁盤類型及其對應性能指標 |
SATA | |
| bootDiskSize | 是 | Integer | 系統盤大小單位為GiB,取值范圍:[40, 32768],注:創建云主機過程中會存在單位轉換,因此該參數只能傳入整型,如果填寫小數值則會被取整,影響到涉及計費,注:創建云主機過程中會存在單位轉換,因此該參數只能傳入整型,如果填寫小數值則會被取整,影響到涉及計費 | 40 | |
| vpcID | 是 | String | 虛擬私有云ID,您可以查看產品定義-虛擬私有云來了解虛擬私有云 獲取: 查 創 注:在多可用區類型資源池下,vpcID通常為“vpc-”開頭,非多可用區類型資源池vpcID為uuid格式 |
4797e8a1-722d-4996-9362-458001813e41 | |
| networkCardList | 是 | Array of Objects | 網卡信息列表,您可以查看彈性網卡概述了解彈性網卡相關信息 | networkCardList | |
| extIP | 是 | String | 是否使用彈性公網IP,取值范圍: 0:不使用, 1:自動分配, 2:使用已有 注:自動分配彈性公網,默認分配IPv4彈性公網,需填寫帶寬大小,如需ipv6請填寫彈性IP版本(即參數extIP="1"時,需填寫參數bandwidth、ipVersion,ipVersion含默認值ipv4) 使用已有彈性公網,請填寫彈性公網IP的ID,默認為ipv4版本,如使用已有ipv6,請填寫彈性ip版本(即參數extIP="2"時,需填寫eipID或ipv6AddressID,同時ipv6情況下請填寫ipVersion) |
2 | |
| secGroupList | 否 | Array of Strings | 安全組ID列表,您可以查看安全組概述了解安全組相關信息 獲取: 查 創 注:在多可用區類型資源池下,安全組ID通常以“sg-”開頭,非多可用區類型資源池安全組ID為uuid格式;默認使用默認安全組,無默認安全組情況下請填寫該參數 |
["202ca2d2-273a-5995-873b-03731212c8e4"] | |
| dataDiskList | 否 | Array of Objects | 數據盤信息列表,注:同一云主機下最多可掛載8塊數據盤 | dataDiskList | |
| ipVersion | 否 | String | 彈性IP版本,取值范圍: ipv4:v4地址, ipv6:v6地址 不指定默認為ipv4。注:請先確認該資源池是否支持ipv6 |
ipv4 | |
| bandwidth | 否 | Integer | 帶寬大小,單位為Mbit/s,取值范圍:[1, 2000] | 100 | |
| ipv6AddressID | 否 | String | 彈性公網IPv6的ID,注:多可用區類資源池暫不支持;填寫該參數時請填寫ipVersion為ipv6 | eip-5sdasd2gfh | |
| eipID | 否 | String | 彈性公網IP的ID,您可以查看產品定義-彈性IP來了解彈性公網IP 獲取: 查 創 |
eip-9jpeyl0frh | |
| affinityGroupID | 否 | String | 云主機組ID,獲取: 查 創 |
259b0c37-1044-41d8-989e | |
| keyPairID | 否 | String | 密鑰對ID,您可以查看密鑰對來了解密鑰對相關內容 獲取: 查 創 |
c57d0626-8a82-407b-a910-b454907778c3 | |
| userPassword | 否 | String | 用戶密碼,滿足以下規則: 長度在8~30個字符 必須包含大寫字母、小寫字母、數字以及特殊符號中的三項; 特殊符號可選:()`~!@#$%^&*_-+=|{}[]:;'<>,.?/\且不能以斜線號 / 開頭 不能包含3個及以上連續字符; Linux鏡像不能包含鏡像用戶名(root)、用戶名的倒序(toor)、用戶名大小寫變化(如RoOt、rOot等) Windows鏡像不能包含鏡像用戶名(Administrator)、用戶名大小寫變化(adminiSTrator等) |
1qaz@WSX | |
| monitorService | 否 | Boolean | 監控參數,支持通過該參數指定云主機在創建后是否開啟詳細監控,取值范圍: false:不開啟, true:開啟 若指定該參數為true或不指定該參數,云主機內默認開啟最新詳細監控服務 若指定該參數為false,默認公共鏡像不開啟最新監控服務;私有鏡像使用鏡像中保留的監控服務 說明:僅部分資源池支持monitorService參數,詳細請參考監控Agent概覽 |
true |
表 dataDiskList
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| diskMode | 否 | String | 云硬盤屬性,取值范圍: FCSAN:光纖通道協議的SAN網絡, ISCSI:小型計算機系統接口, VBD:虛擬塊存儲設備 您可以查看磁盤模式及使用方法 注:默認為VBD |
VBD | |
| diskName | 否 | String | 云硬盤名稱,長度限制2~63字符,不支持中文 | ebs.name | |
| diskType | 是 | String | 云硬盤類型,取值范圍: SATA:普通IO, SAS:高IO, SSD:超高IO, FAST-SSD:極速型SSD 您可以查看磁盤類型及性能介紹磁盤類型相關信息 |
SATA | |
| diskSize | 是 | Integer | 磁盤容量,單位為GB,取值范圍:[10, 32768] | 20 | |
| decTypeID | 否 | String | 專屬云存儲ID | 32af90b5-664c-41c4-bc59-0f88b39eebc2 |
表 networkCards
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| nicName | 否 | String | 長度2~32,支持拉丁字母、中文、數字、下劃線、連字符,中文或英文字母開頭,不能以http:或https:開頭 | net.name | |
| fixedIP | 否 | String | 內網IPv4地址,注:不可使用已占用IP | 192.168.3.20 | |
| isMaster | 是 | Boolean | 是否主網卡,取值范圍: true:表示主網卡, false:表示擴展網卡 注:只能含有一個主網卡 |
true | |
| subnetID | 是 | String | 子網ID,您可以查看基本概念來查找子網的相關定義 獲取: 查 創 注:在多可用區類型資源池下,subnetID通常以“subnet-”開頭,非多可用區類型資源池subnetID為uuid格式 |
a90eebf0-d798-5017-b9f0-9468bb2301c2 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| 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之后,可以使用masterOrderID進一步確認訂單狀態及資源狀態 查詢訂單狀態及資源UUID: 查 |
235145e4489811eda8330242ac110002 | |
| masterOrderNO | String | 訂單號 | 20221010142913884246 | |
| masterResourceID | String | 主資源ID | 3cda4bf48cac42b8b7db3b279d2fc6fb | |
| regionID | String | 資源池ID | 81f7728662dd11ec810800155d307d5b |
枚舉參數
無
請求示例
請求url
無
請求頭header
無
請求體body
示例1:創建一臺云主機,配置各項內容,不使用彈性公網IP
在專屬云內,系統盤選普通IO類型、大小40GB,并增加20GB普通IO類型數據盤。
規格為s7.small.1,鏡像為CentOS8.0 64位,并附帶副網卡指定其名稱和內網IP地址,并配置使用指定安全組,不使用彈性公網IP。
創建到指定專屬宿主機上,并加入安全組,綁定密鑰對
{
"clientToken": "please_create_your_own_clientToken_not_use_dec_create_example_01",
"instanceName": "api-test01",
"displayName": "create-01",
"imageType": 1,
"bootDiskType": "SATA",
"bootDiskSize": 40,
"onDemand": true,
"extIP": "0",
"regionID": "a39b0db2989140c79e6de8c21d50f132",
"azName": "cn-huadong1-jsnj3A-public-ctcloud",
"flavorID": "0457fe14-6ffe-e739-87ad-93e43fc6dbfa",
"imageID": "d39aba04-2470-4eea-acdc-10cb4f962588",
"vpcID": "vpc-gg2ov4ryo5",
"decHostID": "53cbad26-c4bc-34ff-2e89-80fc0940437f",
"networkCardList": [{
"subnetID": "subnet-5zt2og2t3h",
"isMaster": true
}, {
"subnetID": "subnet-975wansb47",
"isMaster": false,
"nicName": "api-test1031",
"fixedIP": "192.168.1.8"
}],
"dataDiskList": [{
"diskMode": "VBD",
"diskName": "disk-01",
"diskSize": 20,
"diskType": "SATA"
}],
"secGroupList": ["sg-1nni47y963"],
"affinityGroupID": "daccb1e1-e2fd-a380-1b37-d9d6f581395e",
"keyPairID": "d0d9d373-3ffa-17fc-38c9-93283a1eb800",
"userPassword": "zxTest1031"
}
示例2:指定已有公網IP,創建云主機
在專屬云內,系統盤選普通IO類型、大小40GB,指定ipv4類型彈性公網,
規格為s7.small.1,鏡像為Ubuntu 18.04 64位。
{
"clientToken": "please_create_your_own_clientToken_not_use_dec_create_example_02",
"instanceName": "api-02",
"displayName": "create-02",
"imageType": 1,
"bootDiskType": "SATA",
"bootDiskSize": 40,
"onDemand": true,
"extIP": "2",
"ipVersion": "ipv4",
"eipID": "eip-trwi2vk023",
"regionID": "a39b0db2989140c79e6de8c21d50f132",
"azName": "cn-huadong1-jsnj3A-public-ctcloud",
"flavorID": "0457fe14-6ffe-e739-87ad-93e43fc6dbfa",
"imageID": "26ec204c-ebe5-47b9-bff9-32da77026228",
"vpcID": "vpc-gg2ov4ryo5",
"decHostID": "53cbad26-c4bc-34ff-2e89-80fc0940437f",
"networkCardList": [{
"subnetID": "subnet-5zt2og2t3h",
"isMaster": true
}]
}
示例3:自動分配公網IP,創建云主機
在專屬云內,系統盤選普通IO類型、大小40GB,自動分配帶寬大小為2Mbit/s的彈性公網,
規格為s7.small.1,鏡像為Ubuntu 18.04 64位。
{
"clientToken": "please_create_your_own_clientToken_not_use_dec_create_example_03",
"instanceName": "api-03",
"displayName": "create-03",
"imageType": 1,
"bootDiskType": "SATA",
"bootDiskSize": 40,
"onDemand": true,
"extIP": "1",
"ipVersion": "ipv4",
"bandwidth": 2,
"regionID": "a39b0db2989140c79e6de8c21d50f132",
"azName": "cn-huadong1-jsnj3A-public-ctcloud",
"flavorID": "0457fe14-6ffe-e739-87ad-93e43fc6dbfa",
"imageID": "d39aba04-2470-4eea-acdc-10cb4f962588",
"vpcID": "vpc-gg2ov4ryo5",
"decHostID": "53cbad26-c4bc-34ff-2e89-80fc0940437f",
"networkCardList": [{
"subnetID": "subnet-5zt2og2t3h",
"isMaster": true
}]
}
響應示例
{
"returnObj": {
"masterResourceID": "39559b25eabf455481aa9e3882d3b0a7",
"masterOrderNO": "20221202173339078653",
"regionID": "ef901a5734964ce29eedac918c4716a3",
"masterOrderID": "0ea2d572722311eda5fb0242ac110002"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
狀態碼
請參考
錯誤碼
請參考