華為云計(jì)算 云知識 創(chuàng)建彈性云服務(wù)器CreateServers
創(chuàng)建彈性云服務(wù)器CreateServers

功能介紹

創(chuàng)建一臺或多臺 云服務(wù)器

V1.1版本創(chuàng)建云服務(wù)器的接口兼容了V1版本創(chuàng)建云服務(wù)器(按需)的功能,同時(shí)合入新功能,支持創(chuàng)建包年/包月的彈性云服務(wù)器。

本接口為異步接口,當(dāng)前創(chuàng)建云服務(wù)器請求下發(fā)成功后會返回job_id,此時(shí)創(chuàng)建云服務(wù)器并沒有立即完成,需要通過調(diào)用查詢?nèi)蝿?wù)的執(zhí)行狀態(tài)查詢job狀態(tài),當(dāng)Job狀態(tài)為 SUC CES S 時(shí)代表云服務(wù)器創(chuàng)建成功。

本接口支持在HTTP請求消息頭中設(shè)置X-Client-Token請求頭,保證請求冪等性。詳細(xì)信息請參考請求冪等性說明。

彈性云服務(wù)器的登錄鑒權(quán)方式包括兩種:密鑰對、密碼。為安全起見,推薦使用密鑰對方式。
  • 密鑰對

    指使用密鑰對作為彈性云服務(wù)器的鑒權(quán)方式。

    接口調(diào)用方法:使用key_name字段,指定彈性云服務(wù)器登錄時(shí)使用的密鑰文件,key_name字段的使用方法請參見表2。

  • 密碼

    指使用設(shè)置初始密碼方式作為彈性云服務(wù)器的鑒權(quán)方式,此時(shí),您可以通過用戶名密碼方式登錄彈性云服務(wù)器,Linux操作系統(tǒng)時(shí)為root用戶的初始密碼,Windows操作系統(tǒng)時(shí)為Administrator用戶的初始密碼。

    接口調(diào)用方法:使用adminPass字段,指定管理員帳號的初始登錄密碼,adminPass字段的使用方法請參見表2。對于 鏡像 已安裝Cloud-init的Linux云服務(wù)器,如果需要使用密文密碼,可以使用user_data字段進(jìn)行密碼注入,具體請參見表2。

    對于安裝Cloud-init鏡像的Linux云服務(wù)器,若指定user_data字段,則adminPass字段無效。

  • 鏡像密碼

    使用Linux操作系統(tǒng)私有鏡像創(chuàng)建云服務(wù)器,支持使用私有鏡像的密碼。

    接口調(diào)用方法:使用鏡像密碼,則無需指定key_name、adminPass字段。

購買操作示例:

接口約束

  • 創(chuàng)建包年/包月云服務(wù)器時(shí),支持自動(dòng)支付和手動(dòng)支付。
    • 如果將請求中的isAutoPay字段設(shè)置為true,表示采用自動(dòng)支付方式,系統(tǒng)會自動(dòng)匹配賬戶支持的付款方式進(jìn)行扣費(fèi)。
      • 自動(dòng)支付支持的付款方式和順序如下:

        折扣優(yōu)惠(每次只能使用一項(xiàng))→代金券(每次只能使用一張)→現(xiàn)金券或儲值卡(每次可使用多張,可同時(shí)使用)→賬戶余額(先扣現(xiàn)金額度后扣信用額度)或月末結(jié)算

      • 如果上述付款方式無法完成支付,系統(tǒng)會自動(dòng)生成一個(gè)待支付訂單,您可以手動(dòng)在控制臺上選擇支付方式進(jìn)行支付。

      自動(dòng)支付的更多內(nèi)容請參見自動(dòng)支付

    • 如果將請求中的isAutoPay字段設(shè)置為false,表示采用手動(dòng)支付方式,系統(tǒng)會自動(dòng)生成一個(gè)待支付訂單,您可以手動(dòng)在控制臺上選擇支付方式進(jìn)行支付。
  • 創(chuàng)建按需計(jì)費(fèi)云服務(wù)器時(shí),系統(tǒng)會自動(dòng)匹配適用的代金券進(jìn)行使用。
  • 如果您需要退訂該包年/包月資源,請參考“退訂包年/包月資源”。

調(diào)試

您可以在API Explorer中調(diào)試該接口。

URI

  • URI格式

    POST /v1.1/{project_id}/cloudservers

  • 參數(shù)說明

    參數(shù)

    是否必選

    描述

    project_id

    項(xiàng)目ID

    獲取方法請參見 獲取項(xiàng)目ID

請求消息

表1 請求參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

server

Object

彈性云服務(wù)器信息,請參見表2。

dry_run

Boolean

是否只預(yù)檢此次請求,默認(rèn)為false。

  • true:發(fā)送檢查請求,不會創(chuàng)建實(shí)例。檢查項(xiàng)包括是否填寫了必需參數(shù)、請求格式等。
    • 如果檢查不通過,則返回對應(yīng)錯(cuò)誤。
    • 如果檢查通過,則返回202狀態(tài)碼。
  • false:發(fā)送正常請求,通過檢查后并且執(zhí)行創(chuàng)建云服務(wù)器請求。
表2 創(chuàng)建云服務(wù)器請求參數(shù)說明

參數(shù)

是否必選

參數(shù)類型

描述

imageRef

String

待創(chuàng)建云服務(wù)器的系統(tǒng)鏡像,需要指定已創(chuàng)建鏡像的ID,ID格式為通用唯一識別碼(Universally Unique Identifier,簡稱UUID)。

鏡像的ID可以從控制臺或者參考 鏡像服務(wù) API參考》的“查詢鏡像列表”的章節(jié)獲取。

flavorRef

String

待創(chuàng)建云服務(wù)器的系統(tǒng)規(guī)格的ID。

已上線的規(guī)格請參見《彈性云服務(wù)器產(chǎn)品介紹》的“實(shí)例類型與規(guī)格”章節(jié)。

name

String

云服務(wù)器名稱。

創(chuàng)建的云服務(wù)器數(shù)量(count字段對應(yīng)的值)等于1時(shí),云服務(wù)器名稱只能由中文字符、英文字母、數(shù)字及“_”、“-”組成,且長度為[1-64]個(gè)字符。

創(chuàng)建的云服務(wù)器數(shù)量(count字段對應(yīng)的值)大于1時(shí),可以使用“自動(dòng)排序”和“正則排序”設(shè)置有序的云服務(wù)器名稱。

請參考創(chuàng)建多臺云服務(wù)器云主機(jī)時(shí)怎樣設(shè)置有序的云服務(wù)器云主機(jī)名稱?

取值范圍:

  • 只能由中文字符、英文字母、數(shù)字及“_”、“-”組成,且長度為[1-64]個(gè)字符。
  • 創(chuàng)建的云服務(wù)器數(shù)量(count字段對應(yīng)的值)大于1時(shí),為區(qū)分不同云服務(wù)器,創(chuàng)建過程中系統(tǒng)會自動(dòng)在名稱后加“-0000”的類似標(biāo)記。若用戶在名稱后已指定“-0000”的類似標(biāo)記,系統(tǒng)將從該標(biāo)記后繼續(xù)順序遞增編號。故此時(shí)名稱的長度為[1-59]個(gè)字符。
    說明:

    彈性云服務(wù)器內(nèi)部主機(jī)名(hostname)命名規(guī)則遵循 RFC 952RFC 1123命名規(guī)范,建議使用a-z或0-9以及中劃線"-"組成的名稱命名,"_"將在彈性云服務(wù)器內(nèi)部默認(rèn)轉(zhuǎn)化為"-"。

user_data

String

創(chuàng)建云服務(wù)器過程中待注入實(shí)例自定義數(shù)據(jù)。支持注入文本、文本文件。

說明:
  • user_data的值為base64編碼之后的內(nèi)容。
  • 注入內(nèi)容(編碼之前的內(nèi)容)最大長度為32K。

更多關(guān)于待注入實(shí)例自定義數(shù)據(jù)的信息,請參見《彈性云服務(wù)器用戶指南 》的“用戶數(shù)據(jù)注入”章節(jié)。

示例:

base64編碼前:

  • Linux服務(wù)器:
    #! /bin/bash
    echo user_test >> /home/user.txt
  • Windows服務(wù)器:
    rem cmd
    echo 111 > c:\aaa.txt

base64編碼后:

  • Linux服務(wù)器:
    IyEgL2Jpbi9iYXNoDQplY2hvIHVzZXJfdGVzdCAmZ3Q7Jmd0OyAvaG9tZS91c2VyLnR4dA==
  • Windows服務(wù)器:
    cmVtIGNtZAplY2hvIDExMSA+IGM6XGFhYS50eHQ=

adminPass

String

如果需要使用密碼方式登錄云服務(wù)器,可使用adminPass字段指定云服務(wù)器管理員帳戶初始登錄密碼。其中,Linux管理員帳戶為root,Windows管理員帳戶為Administrator。

密碼復(fù)雜度要求:
  • 長度為8-26位。
  • 密碼至少必須包含大寫字母、小寫字母、數(shù)字和特殊字符(!@$%^-_=+[{}]:,./?)中的三種。
  • 密碼不能包含用戶名或用戶名的逆序。
  • Windows系統(tǒng)密碼不能包含用戶名或用戶名的逆序,不能包含用戶名中超過兩個(gè)連續(xù)字符的部分。

key_name

String

如果需要使用SSH密鑰方式登錄云服務(wù)器,請指定已創(chuàng)建密鑰的名稱。

密鑰可以通過密鑰創(chuàng)建接口進(jìn)行創(chuàng)建(請參見創(chuàng)建和導(dǎo)入SSH密鑰),或使用SSH密鑰查詢接口查詢已有的密鑰(請參見查詢SSH密鑰列表 )。

約束:

當(dāng)創(chuàng)建云服務(wù)器的extendparam字段中chargingMode為prePaid時(shí)(即包年包月的彈性云服務(wù)器),key_name參數(shù)必須配合metadata字段使用。詳情請參見創(chuàng)建云服務(wù)器的metadata字段數(shù)據(jù)結(jié)構(gòu)說明,以及請求示例1。

vpcid

String

待創(chuàng)建云服務(wù)器所屬 虛擬私有云 (簡稱VPC),需要指定已創(chuàng)建VPC的ID,UUID格式。

VPC的ID可以從控制臺或者參考《虛擬 私有云 接口參考》的“查詢VPC”章節(jié)獲取。

nics

Array of objects

待創(chuàng)建云服務(wù)器的網(wǎng)卡信息。詳情請參見表3

約束:

  • 主網(wǎng)卡對應(yīng)的網(wǎng)絡(luò)(network)必須屬于vpcid對應(yīng)的VPC。用戶創(chuàng)建網(wǎng)卡時(shí),指定的第一張網(wǎng)卡信息為主網(wǎng)卡。
  • 當(dāng)前單個(gè)彈性云服務(wù)器默認(rèn)支持最多掛載12張網(wǎng)卡。
  • 不同的規(guī)格對網(wǎng)卡上限有一定的區(qū)別,參考 規(guī)格清單。

publicip

Object

配置云服務(wù)器的彈性IP信息,彈性IP有三種配置方式。

  • 不使用(無該字段)
  • 自動(dòng)分配,需要指定新創(chuàng)建彈性IP的信息
  • 使用已有,需要指定已創(chuàng)建彈性IP的信息

詳情請參見publicip字段數(shù)據(jù)結(jié)構(gòu)說明

count

Integer

創(chuàng)建云服務(wù)器數(shù)量。

約束:

  • 不傳該字段時(shí)默認(rèn)取值為1。
  • 當(dāng)extendparam結(jié)構(gòu)中的chargingMode為postPaid(即創(chuàng)建按需付費(fèi)的云服務(wù)器),且租戶的配額足夠時(shí),最大值為500。
  • 當(dāng)extendparam結(jié)構(gòu)中的chargingMode為prePaid(即創(chuàng)建包年包月付費(fèi)的云服務(wù)器)時(shí),該值取值范圍為[1,100]。但一次訂購不要超過400個(gè)資源(比如購買一個(gè)彈性云服務(wù)器,至少包含了1個(gè)云主機(jī)、1個(gè)系統(tǒng)盤,有可能還包含數(shù)據(jù)盤、彈性IP、帶寬多個(gè)資源,這些都屬于資源,會算到400個(gè)內(nèi)),超過400個(gè)資源時(shí)報(bào)錯(cuò)。

isAutoRename

Boolean

云服務(wù)器名稱是否允許重名。默認(rèn)為False,當(dāng)count大于1的時(shí)候該參數(shù)生效。

  • True,表示允許重名。
  • False,表示不允許重名。

root_volume

Object

云服務(wù)器對應(yīng)系統(tǒng)盤相關(guān)配置。

創(chuàng)建包年/包月的彈性云服務(wù)器的時(shí)候,創(chuàng)建的系統(tǒng)盤/數(shù)據(jù)盤也是包年/包月,周期和彈性云服務(wù)器一致

詳情請參見表5

data_volumes

Array of objects

云服務(wù)器對應(yīng)數(shù)據(jù)盤相關(guān)配置。每一個(gè)數(shù)據(jù)結(jié)構(gòu)代表一塊待創(chuàng)建的數(shù)據(jù)盤。

約束:目前彈性云服務(wù)器最多可掛載59塊數(shù)據(jù)盤(部分規(guī)格只支持23塊數(shù)據(jù)盤)

詳情請參見表6

security_groups

Array of objects

云服務(wù)器對應(yīng)安全組信息。

約束:當(dāng)該值指定為空時(shí),默認(rèn)給云服務(wù)器綁定default安全組。

詳情請參見security_groups字段數(shù)據(jù)結(jié)構(gòu)說明

availability_zone

String

待創(chuàng)建云服務(wù)器所在的可用區(qū),需要指定可用分區(qū)名稱。

說明:

如果為空,會自動(dòng)指定一個(gè)符合要求的可用區(qū)。

可通過接口 查詢可用區(qū)列表 獲取,也可參考地區(qū)和終端節(jié)點(diǎn)獲取。

batch_create_in_multi_az

Boolean

是否支持隨機(jī)多AZ部署,默認(rèn)為false。

  • true:批量創(chuàng)建的ecs部署在多個(gè)AZ上
  • false:批量創(chuàng)建的ecs部署在單個(gè)AZ上

當(dāng)availability_zone為空時(shí)該字段生效。

extendparam

Object

創(chuàng)建云服務(wù)器附加信息。

詳情請參見表9

metadata

Map<String,String>

創(chuàng)建云服務(wù)器元數(shù)據(jù)。

可以通過元數(shù)據(jù)自定義鍵值對。

說明:
  • 如果元數(shù)據(jù)中包含了敏感數(shù)據(jù),您應(yīng)當(dāng)采取適當(dāng)?shù)拇胧﹣肀Wo(hù)敏感數(shù)據(jù),比如限制訪問范圍、加密等。
  • 最多可注入10對鍵值(Key/Value)。
  • 主鍵(Key)只能由大寫字母(A-Z)、小寫字母(a-z)、數(shù)字(0-9)、中劃線(-)、下劃線(_)、冒號(:)、空格( )和小數(shù)點(diǎn)(.)組成,長度為[1-255]個(gè)字符。
  • 值(value)最大長度為255個(gè)字符。

系統(tǒng)預(yù)留鍵值對請參見表11。

os:scheduler_hints

Object

云服務(wù)器調(diào)度信息,例如設(shè)置云服務(wù)器組。

詳情請參見表12。

tags

Array of strings

彈性云服務(wù)器的標(biāo)簽。

標(biāo)簽的格式為“key.value”。其中,key的長度不超過36個(gè)字符,value的長度不超過43個(gè)字符。

標(biāo)簽命名時(shí),需滿足如下要求:

  • 標(biāo)簽的key值只能包含大寫字母(A~Z)、小寫字母(a~z)、數(shù)字(0-9)、下劃線(_)、中劃線(-)以及中文字符。
  • 標(biāo)簽的value值只能包含大寫字母(A~Z)、小寫字母(a~z)、數(shù)字(0-9)、下劃線(_)、中劃線(-)、小數(shù)點(diǎn)(.)以及中文字符。
說明:
  • 創(chuàng)建彈性云服務(wù)器時(shí),一臺彈性云服務(wù)器最多可以添加10個(gè)標(biāo)簽。
  • 云服務(wù)新增server_tags字段,該字段與tags字段功能相同,支持的key、value取值范圍更廣,建議使用server_tags字段。

server_tags

Array of objects

彈性云服務(wù)器的標(biāo)簽。詳情請參見server_tags字段數(shù)據(jù)結(jié)構(gòu)說明

說明:
  • 創(chuàng)建彈性云服務(wù)器時(shí),一臺彈性云服務(wù)器最多可以添加10個(gè)標(biāo)簽。
  • 云服務(wù)新增server_tags字段,該字段與tags字段功能相同,支持的key、value取值范圍更廣,建議使用server_tags字段。

description

String

云服務(wù)器描述信息,默認(rèn)為空字符串。

  • 長度最多允許85個(gè)字符。
  • 不能包含“<” 和 “>”。

auto_terminate_time

String

該字段尚不支持,功能即將上線,敬請期待。

自動(dòng)釋放時(shí)間。

按照ISO8601標(biāo)準(zhǔn)表示,并使用UTC +0時(shí)間,格式為yyyy-MM-ddTHH:mm:ssZ。

如果秒(ss)取值不是 00,則自動(dòng)取為當(dāng)前分鐘(mm)開始時(shí)。

最短釋放時(shí)間為當(dāng)前時(shí)間半小時(shí)之后。

最長釋放時(shí)間不能超過當(dāng)前時(shí)間三年。

示例:2020-09-25T12:05:00Z

說明:

僅按需實(shí)例支持設(shè)置自動(dòng)釋放時(shí)間。

表3 nics字段數(shù)據(jù)結(jié)構(gòu)說明

參數(shù)

是否必選

參數(shù)類型

描述

subnet_id

String

待創(chuàng)建云服務(wù)器所在的子網(wǎng)信息。

需要指定vpcid對應(yīng)VPC下已創(chuàng)建的子網(wǎng)(subnet)的網(wǎng)絡(luò)ID,UUID格式。

可以通過VPC服務(wù)查詢子網(wǎng)列表接口查詢。

ip_address

String

待創(chuàng)建云服務(wù)器網(wǎng)卡的IP地址,IPv4格式。

約束:
  • 不填或空字符串,默認(rèn)在子網(wǎng)(subnet)中自動(dòng)分配一個(gè)未使用的IP作網(wǎng)卡的IP地址。
  • 若指定IP地址,該IP地址必須在子網(wǎng)(subnet)對應(yīng)的網(wǎng)段內(nèi),且未被使用。

ipv6_enable

Boolean

是否支持ipv6。取值為true時(shí),表示此網(wǎng)卡支持ipv6。

ipv6_bandwidth

Object

綁定的共享帶寬信息,詳情請參見ipv6_bandwidth字段數(shù)據(jù)結(jié)構(gòu)說明。

allowed_address_pairs

Array of allow_address_pair objects

IP/Mac對列表,詳情請參見表4(擴(kuò)展屬性)。

約束:IP地址不允許為 “0.0.0.0/0”

  • 如果allowed_address_pairs配置地址池較大的CIDR(掩碼小于24位),建議為該port配置一個(gè)單獨(dú)的安全組
  • 如果allowed_address_pairs為“1.1.1.1/0”,表示關(guān)閉源目地址檢查開關(guān)
  • 被綁定的云服務(wù)器網(wǎng)卡allowed_address_pairs填“1.1.1.1/0”
表4 allow_address_pair對象

名稱

是否必選

參數(shù)類型

說明

ip_address

String

IP地址。

約束:不支持0.0.0.0/0

如果allowed_address_pairs配置地址池較大的CIDR(掩碼小于24位),建議為該port配置一個(gè)單獨(dú)的安全組。

mac_address

String

MAC地址。

表5 root_volume字段數(shù)據(jù)結(jié)構(gòu)說明

參數(shù)

是否必選

參數(shù)類型

描述

volumetype

String

云服務(wù)器系統(tǒng)盤對應(yīng)的磁盤類型,需要與系統(tǒng)所提供的磁盤類型相匹配。

目前支持“SATA”,“SAS”,“GPSSD”,“SSD”,“ESSD”。
  • “SATA”為普通IO 云硬盤 (已售罄)
  • “SAS”為高IO云硬盤
  • “GPSSD”為通用型SSD云硬盤
  • “SSD”為超高IO云硬盤
  • “ESSD”為極速IO云硬盤

當(dāng)指定的云硬盤類型在avaliability_zone內(nèi)不存在時(shí),則創(chuàng)建云硬盤失敗。

說明:

size

Integer

系統(tǒng)盤大小,容量單位為GB, 輸入大小范圍為[1,1024]。

約束:

  • 系統(tǒng)盤大小取值應(yīng)不小于鏡像支持的系統(tǒng)盤的最小值(鏡像的min_disk屬性)。
  • 若該參數(shù)沒有指定或者指定為0時(shí),系統(tǒng)盤大小默認(rèn)取值為鏡像中系統(tǒng)盤的最小值(鏡像的min_disk屬性)。
    說明:

    鏡像系統(tǒng)盤的最小值(鏡像的min_disk屬性)可在控制臺上單擊鏡像詳情查看?;蛲ㄟ^調(diào)用“查詢鏡像詳情(OpenStack原生)”API獲取,詳細(xì)操作請參考《鏡像服務(wù)API參考》中“查詢鏡像詳情(OpenStack原生)”章節(jié)。

extendparam

Object

磁盤的產(chǎn)品信息。

詳情請參見創(chuàng)建磁盤的extendparam字段數(shù)據(jù)結(jié)構(gòu)說明

cluster_type

String

云服務(wù)器系統(tǒng)盤對應(yīng)的磁盤存儲類型。

磁盤存儲類型枚舉值:DSS(專屬存儲類型)

該參數(shù)需要與“cluster_id”配合使用,僅當(dāng)“cluster_id”不為空時(shí),才可以成功創(chuàng)建專屬存儲類型的磁盤。

cluster_id

String

云服務(wù)器系統(tǒng)盤對應(yīng)的存儲池的ID。

hw:passthrough

Boolean

設(shè)置云硬盤的設(shè)備類型:
  • 參數(shù)指定為false,創(chuàng)建VBD類型磁盤。
  • 參數(shù)指定為true,創(chuàng)建SCSI類型磁盤。
  • 參數(shù)未指定或者指定非Boolean類型的字符,默認(rèn)創(chuàng)建VBD類型磁盤。
說明:

非擎天規(guī)格僅支持設(shè)置系統(tǒng)盤為VBD類型。

metadata

Object

創(chuàng)建云硬盤的metadata信息,metadata中的key和value長度不大于255個(gè)字節(jié)。

僅在創(chuàng)建加密盤時(shí)使用metadata字段。

詳情請參見創(chuàng)建磁盤的metadata字段數(shù)據(jù)結(jié)構(gòu)說明

表6 data_volumes字段數(shù)據(jù)結(jié)構(gòu)說明

參數(shù)

是否必選

參數(shù)類型

描述

volumetype

String

云服務(wù)器數(shù)據(jù)盤對應(yīng)的磁盤類型,需要與系統(tǒng)所提供的磁盤類型相匹配。

目前支持“SATA”,“SAS”,“GPSSD”,“SSD”,“ESSD”。
  • “SATA”為普通IO云硬盤(已售罄)
  • “SAS”為高IO云硬盤
  • “GPSSD”為通用型SSD云硬盤
  • “SSD”為超高IO云硬盤
  • “ESSD”為極速IO云硬盤

當(dāng)指定的云硬盤類型在avaliability_zone內(nèi)不存在時(shí),則創(chuàng)建云硬盤失敗。

說明:

size

Integer

數(shù)據(jù)盤大小,容量單位為GB,輸入大小范圍為[10,32768]。

如果使用數(shù)據(jù)盤鏡像創(chuàng)建數(shù)據(jù)盤時(shí),size取值不能小于創(chuàng)建數(shù)據(jù)盤鏡像的源數(shù)據(jù)盤的大小。

shareable

Boolean

是否為共享磁盤。true為共享盤,false為普通云硬盤。

說明:

該字段已廢棄,請使用multiattach。

multiattach

Boolean

創(chuàng)建共享磁盤的信息。

  • true:創(chuàng)建的磁盤為共享盤。
  • false:創(chuàng)建的磁盤為普通云硬盤。
說明:
  • 當(dāng)參數(shù)取值為true時(shí),表明為共享盤,創(chuàng)建的磁盤類型為SCSI。
  • shareable當(dāng)前為廢棄字段,如果確實(shí)需要同時(shí)使用shareable字段和multiattach字段,此時(shí),請確保兩個(gè)字段的參數(shù)值相同。當(dāng)不指定該字段時(shí),系統(tǒng)默認(rèn)創(chuàng)建普通云硬盤。

hw:passthrough

Boolean

設(shè)置云硬盤的設(shè)備類型:
  • 參數(shù)指定為false,創(chuàng)建VBD類型磁盤。
  • 參數(shù)指定為true,創(chuàng)建SCSI類型磁盤。
  • 參數(shù)未指定或者指定非Boolean類型的字符,默認(rèn)創(chuàng)建VBD類型磁盤。
說明:

非擎天規(guī)格僅支持設(shè)置系統(tǒng)盤為VBD類型。

extendparam

Object

磁盤的產(chǎn)品信息。

詳情請參見表7。

cluster_type

String

云服務(wù)器數(shù)據(jù)盤對應(yīng)的磁盤存儲類型。

磁盤存儲類型枚舉值:DSS(專屬存儲類型)

該參數(shù)需要與“cluster_id”配合使用,僅當(dāng)“cluster_id”不為空時(shí),才可以成功創(chuàng)建專屬存儲類型的磁盤。

cluster_id

String

云服務(wù)器數(shù)據(jù)盤對應(yīng)的存儲池的ID。

data_image_id

String

數(shù)據(jù)鏡像的ID,UUID格式。

如果使用數(shù)據(jù)盤鏡像創(chuàng)建數(shù)據(jù)盤,則data_image_id為必選參數(shù),且不支持使用metadata。

metadata

Object

創(chuàng)建云硬盤的metadata信息,metadata中的key和value長度不大于255個(gè)字節(jié)。

僅在創(chuàng)建加密盤時(shí)使用metadata字段。

如果使用數(shù)據(jù)盤鏡像創(chuàng)建數(shù)據(jù)盤,不支持使用metadata。

詳情請參見創(chuàng)建磁盤的metadata字段數(shù)據(jù)結(jié)構(gòu)說明

delete_on_termination

Boolean

數(shù)據(jù)盤隨實(shí)例釋放策略

  • true:數(shù)據(jù)盤隨實(shí)例釋放。
  • false:數(shù)據(jù)盤不隨實(shí)例釋放。

默認(rèn)值:false

說明:

該字段僅按需、競價(jià)實(shí)例支持。

響應(yīng)消息

表7 響應(yīng)參數(shù)

參數(shù)

參數(shù)類型

描述

job_id

String

提交任務(wù)成功后返回的任務(wù)ID,用戶可以使用該ID對任務(wù)執(zhí)行情況進(jìn)行查詢。如何根據(jù)job_id來查詢Job的執(zhí)行狀態(tài),請參考查詢Job狀態(tài)。

order_id

String

訂單號,創(chuàng)建包年包月的彈性云服務(wù)器時(shí)返回該參數(shù)。

說明:

serverIds

Array of strings

云服務(wù)器ID列表。

說明:

通過云服務(wù)器ID查詢云服務(wù)器詳情 ,若返回404 可能云服務(wù)器還在創(chuàng)建或者已經(jīng)創(chuàng)建失敗。

異常響應(yīng)請參考響應(yīng)(任務(wù)類),異常響應(yīng)要素說明。

請求示例

  • 創(chuàng)建一臺包年/包月云服務(wù)器,操作系統(tǒng)為CentOS 7.6 64bit,1U1G,綁定1M帶寬的 彈性公網(wǎng)IP ,采用密鑰方式登錄鑒權(quán)。
    POST https://{endpoint}/v1.1/{project_id}/cloudservers
    
    {
        "server": {
            "availability_zone":"az1-dc1",
            "name": "newserver", 
            "imageRef": "67f433d8-ed0e-4321-a8a2-a71838539e09", 
            "root_volume": {
                "volumetype": "SSD"
            }, 
            "data_volumes": [
                {
                    "volumetype": "SSD", 
                    "size": 100
                }, 
                {
                    "volumetype": "SSD", 
                    "size": 100,
                    "multiattach": true,
                    "hw:passthrough": true
                }
            ], 
            "flavorRef": "s2.small.1", 
            "vpcid": "2a6f4aa6-d93e-45f5-a8cb-b030dbf8cd68", 
            "security_groups": [
                {
                    "id": "6242ef48-4d35-49c8-8711-a6e54902e44a"
                }
            ], 
            "nics": [
                {
                    "subnet_id": "ef039b60-6a14-42d1-963b-687b627fea08"
                }
            ], 
            "publicip": {
                "eip": {
                    "iptype": "5_sbgp",
                    "bandwidth": {
                        "size": 1, 
                        "sharetype": "PER"
                    }
                }
            }, 
            "key_name": "id_rsa", 
            "count": 1, 
            "metadata": {
                "op_svc_userid": "f79791beca3c48159ac2553fff22e166"
            },
            "extendparam": { 
                "chargingMode": "prePaid",
                "periodType": "month",
                "periodNum": 1,
                "isAutoRenew": "true",
                "isAutoPay": "true",
                "enterprise_project_id": "f8e0ecc8-3825-4ee8-9596-fb4258ffdcbb"
            },
            "os:scheduler_hints": {
              "group": "cdbbfffe-ef18-47b4-a5c8-f61a984c0ecc"
            }
            
        }
    }
  • 創(chuàng)建一臺包年/包月云服務(wù)器,操作系統(tǒng)為CentOS 7.6 64bit,1U1G,綁定1M帶寬的彈性 公網(wǎng)IP ,采用密碼方式登錄鑒權(quán)。
    POST https://{endpoint}/v1.1/{project_id}/cloudservers
    
    {
        "server": {
            "availability_zone":"az1-dc1",
            "name": "newserver",
            "adminPass": "P@ssw0rd123",
            "imageRef": "67f433d8-ed0e-4321-a8a2-a71838539e09",
            "root_volume": {
                "volumetype": "SSD"
            },
            "data_volumes": [
                {
                    "volumetype": "SSD",
                    "size": 100
                },
                {
                    "volumetype": "SSD",
                    "size": 100,
                    "multiattach": true,
                    "hw:passthrough": true
                }
            ],
            "flavorRef": "s2.small.1",
            "vpcid": "2a6f4aa6-d93e-45f5-a8cb-b030dbf8cd68",
            "security_groups": [
                {
                    "id": "6242ef48-4d35-49c8-8711-a6e54902e44a"
                }
            ],
            "nics": [
                {
                    "subnet_id": "ef039b60-6a14-42d1-963b-687b627fea08"
                }
            ],
            "publicip": {
                "eip": {
                    "iptype": "5_sbgp",
                    "bandwidth": {
                        "size": 1,
                        "sharetype": "PER"
                    }
                }
            },
            "key_name": "",
            "count": 1,
            "metadata": {},
            "extendparam": {
                "chargingMode": "prePaid",
                "periodType": "month",
                "periodNum": 1,
                "isAutoRenew": "true",
                "isAutoPay": "true",
                "enterprise_project_id": "f8e0ecc8-3825-4ee8-9596-fb4258ffdcbb"
            },
            "os:scheduler_hints": {
                "group": "cdbbfffe-ef18-47b4-a5c8-f61a984c0ecc"
            }
        }
    }
  • 創(chuàng)建一臺包年/包月云服務(wù)器,操作系統(tǒng)為CentOS 7.6 64bit,1U1G,綁定1M帶寬的按需按流量計(jì)費(fèi)的彈性公網(wǎng)IP,采用密鑰方式登錄鑒權(quán)。
    POST https://{endpoint}/v1.1/{project_id}/cloudservers
    
    {
        "server": {
            "availability_zone":"az1-dc1",
            "name": "newserver", 
            "imageRef": "67f433d8-ed0e-4321-a8a2-a71838539e09", 
            "root_volume": {
                "volumetype": "SSD"
            }, 
            "data_volumes": [
                {
                    "volumetype": "SSD", 
                    "size": 100
                }, 
                {
                    "volumetype": "SSD", 
                    "size": 100,
                    "multiattach": true,
                    "hw:passthrough": true
                }
            ], 
            "flavorRef": "s2.small.1", 
            "vpcid": "2a6f4aa6-d93e-45f5-a8cb-b030dbf8cd68", 
            "security_groups": [
                {
                    "id": "6242ef48-4d35-49c8-8711-a6e54902e44a"
                }
            ], 
            "nics": [
                {
                    "subnet_id": "ef039b60-6a14-42d1-963b-687b627fea08"
                }
            ], 
            "publicip": {
                "eip": {
                    "iptype": "5_sbgp",
                    "bandwidth": {
                        "size": 1, 
                        "sharetype": "PER",
                        "chargemode": "traffic"
                    },
                    "extendparam": {
                        "chargingMode": "postPaid"
                    }
                }
            }, 
            "key_name": "id_rsa", 
            "count": 1, 
            "metadata": {
                "op_svc_userid": "f79791beca3c48159ac2553fff22e166"
            },
            "extendparam": { 
                "chargingMode": "prePaid",
                "periodType": "month",
                "periodNum": 1,
                "isAutoRenew": "true",
                "isAutoPay": "true",
                "enterprise_project_id": "f8e0ecc8-3825-4ee8-9596-fb4258ffdcbb"
            },
            "os:scheduler_hints": {
              "group": "cdbbfffe-ef18-47b4-a5c8-f61a984c0ecc"
            }
        }
    }
  • 創(chuàng)建一臺包年/包月云服務(wù)器,操作系統(tǒng)為CentOS 7.6 64bit,1U1G,綁定共享帶寬的彈性公網(wǎng)IP,采用密鑰方式登錄鑒權(quán)。
    POST https://{endpoint}/v1.1/{project_id}/cloudservers
    
    {
        "server": {
            "availability_zone":"az1-dc1",
            "name": "newserver", 
            "imageRef": "67f433d8-ed0e-4321-a8a2-a71838539e09", 
            "root_volume": {
                "volumetype": "SSD"
            }, 
            "data_volumes": [
                {
                    "volumetype": "SSD", 
                    "size": 100
                }, 
                {
                    "volumetype": "SSD", 
                    "size": 100,
                    "multiattach": true,
                    "hw:passthrough": true
                }
            ], 
            "flavorRef": "s2.small.1", 
            "vpcid": "2a6f4aa6-d93e-45f5-a8cb-b030dbf8cd68", 
            "security_groups": [
                {
                    "id": "6242ef48-4d35-49c8-8711-a6e54902e44a"
                }
            ], 
            "nics": [
                {
                    "subnet_id": "ef039b60-6a14-42d1-963b-687b627fea08"
                }
            ], 
            "publicip": {
                "eip": {
                    "iptype": "5_sbgp",
                    "bandwidth": {
                        "id": "a0d4b26f-699d-49a0-bcc8-6f707a925abf",
                        "sharetype": "WHOLE"
                    }
                }
            }, 
            "key_name": "id_rsa", 
            "count": 1, 
            "metadata": {
                "op_svc_userid": "f79791beca3c48159ac2553fff22e166",
                "agency_name": "test"
            },
            "extendparam": { 
                "chargingMode": "prePaid",
                "periodType": "month",
                "periodNum": 1,
                "isAutoRenew": "true",
                "isAutoPay": "true",
                "enterprise_project_id": "f8e0ecc8-3825-4ee8-9596-fb4258ffdcbb"
            },
            "os:scheduler_hints": {
              "group": "cdbbfffe-ef18-47b4-a5c8-f61a984c0ecc"
            }
        }
    }
  • 發(fā)送預(yù)校驗(yàn)請求,檢查創(chuàng)建云服務(wù)器的請求消息是否填寫了必選參數(shù),請求格式是否正確。
    POST https://{endpoint}/v1.1/{project_id}/cloudservers
    
    {
        "dry_run": true,
        "server": {
            "availability_zone":"az1-dc1", 
            "name": "server", 
            "imageRef": "ff49b1f1-3e3e-4913-89c6-a026041661e8", 
            "root_volume": {
                "volumetype": "SSD"
            }, 
            "data_volumes": [
                {                 
                    "volumetype": "SSD",                  
                    "size": 100             
                 },              
                {                 
                    "volumetype": "SSD",                  
                    "size": 100,                 
                    "multiattach": true,                 
                    "hw:passthrough": true             
                 }
            ], 
            "flavorRef": "s2.large.2", 
            "vpcid": "0dae26c9-9a70-4392-93f3-87d53115d171", 
            "security_groups": [
                {
                    "id": "507ca48f-814c-4293-8706-300564d54620"
                }
            ], 
            "nics": [
                {
                    "subnet_id": "157ee789-03ea-45b1-a698-76c92660dd83"
                }
            ],
            "key_name": "sshkey-123"
        }
    }

響應(yīng)示例

{
    "job_id": "ff808082739334d80173943ec9b42130",
    "order_id": "CS2007281506xxxxx",
    "serverIds": [
        "fe0528f0-5b1c-4c8c-9adf-e5d5047b8c17",
        "679854ae-a50d-40c9-8132-b19bf3a306a1"
    ] 
}

{
    "error": {
        "code": "Ecs.0005", 
        "message": "request body is illegal."
    }
}

{
    "error": {
        "message": "privateIp [%s] is not in this subnet [%s]",
        "code": "Ecs.0005",
        "details": [
            {
                "code": "Ecs.0039"
            }
        ]
    }
}

返回值

請參考通用請求返回值

錯(cuò)誤碼

請參考錯(cuò)誤碼。