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

 

功能介紹

創(chuàng)建一臺(tái)按需彈性 云服務(wù)器 。

該接口在云服務(wù)器創(chuàng)建失敗后不支持自動(dòng)回滾。若需要自動(dòng)回滾能力,可以調(diào)用POST /v1/{project_id}/cloudservers接口,具體使用請(qǐng)參見(jiàn)創(chuàng)建云服務(wù)器(按需)。

調(diào)試

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

URI

POST /v2.1/{project_id}/servers

參數(shù)說(shuō)明請(qǐng)參見(jiàn)表1。

 

參數(shù)說(shuō)明

參數(shù)

是否必選

描述

project_id

項(xiàng)目ID。

獲取方法請(qǐng)參見(jiàn)獲取項(xiàng)目ID。

創(chuàng)建彈性云服務(wù)器接口別名:/v2/{project_id}/os-volumes_boot,該調(diào)用方式僅在OpenStack Client中使用,用戶不推薦使用。

接口約束

  1. 該接口為原生接口,不支持整機(jī) 鏡像 創(chuàng)建彈性云服務(wù)器功能。如需使用整機(jī)鏡像創(chuàng)建彈性云服務(wù)器,請(qǐng)使用創(chuàng)建云服務(wù)器(按需)。
  2. 該接口為原生接口,不支持創(chuàng)建競(jìng)價(jià)實(shí)例。如需創(chuàng)建競(jìng)價(jià)實(shí)例請(qǐng)使用創(chuàng)建云服務(wù)器、創(chuàng)建云服務(wù)器(按需)。
  3. 該接口為原生接口,不支持創(chuàng)建包年/包月計(jì)費(fèi)模式的實(shí)例。如需創(chuàng)建包年/包月計(jì)費(fèi)模式的云服務(wù)器請(qǐng)使用創(chuàng)建云服務(wù)器
  4. 使用該接口創(chuàng)建的云服務(wù)器,不支持在創(chuàng)建過(guò)程中綁定 彈性公網(wǎng)IP ,推薦使用創(chuàng)建云服務(wù)器(按需)創(chuàng)建云服務(wù)器并綁定彈性 公網(wǎng)IP 。
  5. 網(wǎng)絡(luò)的三個(gè)參數(shù)(port、uuid和fixed_ip)中,port優(yōu)先級(jí)最高;指定fixed_ip時(shí)必須指明uuid。
  6. 注入文件失敗,將導(dǎo)致創(chuàng)建彈性云服務(wù)器失敗。
  7. 使用鏡像創(chuàng)建彈性云服務(wù)器時(shí),存在下面約束:
    1. 不支持指定Host創(chuàng)建彈性云服務(wù)器。
    2. 租戶如果對(duì)彈性云服務(wù)器中的卷進(jìn)行了備份,則需要租戶自行刪除該卷所對(duì)應(yīng)的快照等數(shù)據(jù)后,才能刪除卷。
    3. 調(diào)整鏡像創(chuàng)建的彈性云服務(wù)器規(guī)格時(shí),不支持resource_type不同的flavor之間的規(guī)格調(diào)整。
  8. 云服務(wù)平臺(tái)提供的原生接口/v2/{project_id}/servers 和 /v2.1/{project_id}/servers 是基于社區(qū)版OpenStack原生接口加固而成的,兼容社區(qū)版OpenStack原生接口。較之社區(qū)版的OpenStack原生接口,在使用指定鏡像的方式創(chuàng)建彈性云服務(wù)器時(shí)存在如下差異:
    • 社區(qū)OpenStack原生接口:默認(rèn)使用服務(wù)器本地磁盤(pán)創(chuàng)建彈性云服務(wù)器。
    • 云服務(wù)平臺(tái)提供的原生接口:為了保障可靠性,使用共享存儲(chǔ)作為系統(tǒng)盤(pán)創(chuàng)建彈性云服務(wù)器。
  9. 該差異的具體表現(xiàn)為,當(dāng)您使用提供的原生接口創(chuàng)建云服務(wù)器時(shí):
    1. 可以查詢到云服務(wù)器掛載的系統(tǒng)盤(pán)信息。
    2. 云服務(wù)器的系統(tǒng)盤(pán)會(huì)占用 云硬盤(pán) 的配額。
    3. 不支持使用image過(guò)濾查詢指定鏡像方式創(chuàng)建的彈性云服務(wù)器。
  10. 指定卷創(chuàng)建彈性云服務(wù)器場(chǎng)景下,指定的卷與創(chuàng)建的彈性云服務(wù)器必須處于相同的AZ(availability_zone)。
  11. 用戶創(chuàng)建彈性云服務(wù)器時(shí)在block_device_mapping_v2設(shè)置的device_name字段不會(huì)生效,系統(tǒng)會(huì)默認(rèn)生成一個(gè)device_name。
  12. 請(qǐng)勿使用“provider:network_type”為“geneve”的網(wǎng)絡(luò)來(lái)創(chuàng)建彈性云服務(wù)器。“provider:network_type”為“geneve”時(shí),表示 裸金屬服務(wù)器 使用的內(nèi)部高速網(wǎng)絡(luò)。
  13. 如果使用密鑰方式遠(yuǎn)程登錄云服務(wù)器,請(qǐng)使用key_name參數(shù)。如果使用密碼方式遠(yuǎn)程登錄云服務(wù)器,可使用adminPass參數(shù);對(duì)于Linux云服務(wù)器,還可使用user_data進(jìn)行注入,對(duì)于Windows云服務(wù)器,還可通過(guò)元數(shù)據(jù)admin_pass進(jìn)行注入。

請(qǐng)求消息

請(qǐng)求參數(shù)如表2所示。

 

請(qǐng)求參數(shù)

參數(shù)

是否必選

參數(shù)類(lèi)型

描述

server

Object

彈性云服務(wù)器信息,參見(jiàn)表3。

os:scheduler_hints

Object

彈性云服務(wù)器調(diào)度信息,參見(jiàn)表8。裸金屬服務(wù)器場(chǎng)景不支持。

 

server參數(shù)信息

參數(shù)

是否必選

參數(shù)類(lèi)型

imageRef

String

flavorRef

String

name

String

metadata

Map<String,String>

adminPass

String

block_device_mapping_v2

Array of objects

config_drive

String

security_groups

Array of objects

networks

Array of objects

key_name

String

user_data

String

availability_zone

String

return_reservation_id

Boolean

min_count

Integer

max_count

Integer

OS-DCF:diskConfig

String

description

String

auto_terminate_time

String

 

metadata字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

是否必選

參數(shù)類(lèi)型

描述

admin_pass

String

Windows彈性云服務(wù)器Administrator用戶的密碼。

說(shuō)明:

創(chuàng)建密碼方式鑒權(quán)的Windows彈性云服務(wù)器時(shí)為必選字段。

 

block_device_mapping_v2參數(shù)

參數(shù)

參數(shù)類(lèi)型

是否必選

描述

source_type

String

卷設(shè)備的源頭類(lèi)型,當(dāng)前只支持volume、image、snapshot、blank類(lèi)型。

當(dāng)使用卷創(chuàng)建云服務(wù)器時(shí),source_type設(shè)置為volume;當(dāng)使用鏡像創(chuàng)建云服務(wù)器時(shí),source_type設(shè)置為image;當(dāng)使用快照創(chuàng)建云服務(wù)器時(shí),source_type設(shè)置為snapshot;當(dāng)創(chuàng)建空數(shù)據(jù)卷時(shí),source_type設(shè)置為blank。

說(shuō)明:

當(dāng)卷設(shè)備的源頭類(lèi)型為snapshot時(shí),且boot_index為0,則該快照對(duì)應(yīng)的云硬盤(pán)必須為系統(tǒng)盤(pán)。

destination_type

String

卷設(shè)備的目標(biāo)類(lèi)型,當(dāng)前僅支持volume類(lèi)型。

  • volume:卷。
  • local:本地文件,當(dāng)前不支持該類(lèi)型。

guest_format

String

local文件系統(tǒng)格式,例如:swap, ext4。

當(dāng)前不支持該功能。

device_name

String

卷設(shè)備名稱。

說(shuō)明:

該字段已經(jīng)廢棄。

用戶指定的device_name不會(huì)生效,系統(tǒng)會(huì)默認(rèn)生成一個(gè)device_name。

delete_on_termination

Boolean

刪除彈性云服務(wù)器時(shí),是否刪除卷,默認(rèn)值false。

  • true:刪除彈性云服務(wù)器時(shí),刪除卷
  • false:刪除彈性云服務(wù)器時(shí),不刪除卷

boot_index

String

啟動(dòng)標(biāo)識(shí),“0”代表啟動(dòng)盤(pán),“-1”代表非啟動(dòng)盤(pán)。

不傳該字段時(shí)默認(rèn)取值為“-1”。

說(shuō)明:

當(dāng)卷設(shè)備的源頭類(lèi)型全為volume時(shí),boot_index的值有一個(gè)為0。

uuid

String

  • 當(dāng)source_type值是volume時(shí),uuid為卷的uuid;
  • 當(dāng)source_type值是snapshot時(shí),uuid為快照的uuid;
  • 當(dāng)source_type值是image時(shí),uuid為鏡像的uuid;

volume_size

Integer

卷大小,整數(shù),在source_type是image或blank,destination_type是volume的時(shí)候必選。

單位為GB。

volume_type

String

卷類(lèi)型,在source_type是image,destination_type是volume時(shí)建議填寫(xiě)。

卷類(lèi)型取值范圍請(qǐng)參考 EVS 服務(wù) 磁盤(pán)類(lèi)型介紹 。

 

security_groups參數(shù)

參數(shù)

是否必選

參數(shù)類(lèi)型

描述

name

String

安全組名稱或者uuid。

 

networks參數(shù)

參數(shù)

是否必選

參數(shù)類(lèi)型

描述

port

String

網(wǎng)絡(luò)port uuid。

沒(méi)有指定網(wǎng)絡(luò)uuid時(shí)必須指定。

uuid

String

網(wǎng)絡(luò)uuid。

沒(méi)有指定網(wǎng)絡(luò)port時(shí)必須指定。

fixed_ip

String

指定的IP地址。網(wǎng)絡(luò)的三個(gè)參數(shù)(port、uuid和fixed_ip)中,port優(yōu)先級(jí)最高;指定fixed_ip時(shí)必須指明uuid。

 

os:scheduler_hints參數(shù)

參數(shù)

是否必選

參數(shù)類(lèi)型

描述

group

String

反親和性組信息。

UUID格式。

說(shuō)明:

請(qǐng)確保云服務(wù)器組使用的是反親和性anti-affinity策略,不推薦使用其他策略。

different_host

Array of strings

預(yù)留字段,當(dāng)前不支持該功能。

same_host

Array of strings

預(yù)留字段,當(dāng)前不支持該功能。

cidr

String

預(yù)留字段,當(dāng)前不支持該功能。

build_near_host_ip

String

預(yù)留字段,當(dāng)前不支持該功能。

tenancy

String

專(zhuān)屬主機(jī) 或共享池中創(chuàng)建彈性云服務(wù)器。默認(rèn)為在共享池創(chuàng)建。

值為: shareddedicated。

  • shared:表示共享池。
  • dedicated:表示專(zhuān)屬主機(jī)。

創(chuàng)建與查詢此值均有效。

dedicated_host_id

String

專(zhuān)屬主機(jī)ID。

此屬性僅在tenancy值為dedicated時(shí)有效。

不指定此屬性,系統(tǒng)將自動(dòng)分配租戶可自動(dòng)放置彈性云服務(wù)器的專(zhuān)屬主機(jī)。

創(chuàng)建與查詢此值均有效。

響應(yīng)消息

響應(yīng)參數(shù)如表9所示。

 

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

參數(shù)

參數(shù)類(lèi)型

描述

server

Object

云服務(wù)器信息,詳情請(qǐng)參見(jiàn)表10。

 

server字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

參數(shù)類(lèi)型

描述

id

String

彈性云服務(wù)器ID,UUID格式。

links

Array of objects

彈性云服務(wù)器URI自描述信息,詳情參見(jiàn)表11。

security_groups

Array of objects

彈性云服務(wù)器所在安全組,詳情參見(jiàn)表12。

OS-DCF:diskConfig

String

diskConfig方式。

  • MANUAL,鏡像空間不會(huì)擴(kuò)展。
  • AUTO,系統(tǒng)盤(pán)鏡像空間會(huì)自動(dòng)擴(kuò)展為與flavor大小一致。

reservation_id

String

reservation_id:通過(guò)返回的reservation_id,可以過(guò)濾查詢到本次創(chuàng)建的彈性云服務(wù)器。

說(shuō)明:

批量創(chuàng)建彈性云服務(wù)器時(shí),支持使用該字段。

adminPass

String

Windows彈性云服務(wù)器Administrator用戶的密碼。

 

links字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

參數(shù)類(lèi)型

描述

rel

String

快捷鏈接標(biāo)記名稱。

href

String

對(duì)應(yīng)快捷鏈接。

 

security_groups字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

參數(shù)類(lèi)型

描述

name

String

安全組名稱或者uuid。

請(qǐng)求示例

  • 通過(guò)block_device_mapping_v2擴(kuò)展屬性使用鏡像創(chuàng)建一臺(tái)云服務(wù)器,采用密鑰方式登錄鑒權(quán)。POST https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/servers { "server": { "flavorRef": "2", "name": "wjvm48", "metadata": { "name": "name_xx1", "id": "id_xxxx1" }, "block_device_mapping_v2": [{ "source_type": "image", "destination_type": "volume", "uuid": "b023fe17-11db-4efb-b800-78882a0e394b", "delete_on_termination": "False", "boot_index": "0", "volume_type": "SAS", "volume_size": "40" }], "security_groups": [{ "name": "name_xx5_sg" }], "networks": [{ "uuid": "fd40e6f8-942d-4b4e-a7ae-465287b02a2c", "port": "e730a11c-1a19-49cc-8797-cee2ad67af6f", "fixed_ip": "10.20.30.137" }], "key_name": "test", "user_data": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1
  • 通過(guò)block_device_mapping_v2擴(kuò)展屬性使用快照創(chuàng)建一臺(tái)云服務(wù)器,其中,boot_index為0,且該快照對(duì)應(yīng)的云硬盤(pán)必須為系統(tǒng)盤(pán)。POST https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/servers { "server":{ "name":"wjvm48", "availability_zone":"az1-dc1", "block_device_mapping_v2": [ { "source_type":"snapshot", "boot_index":"0", "uuid":"df51997d-ee35-4fb3-a372-e2ac933a6565", // snapshot id,創(chuàng)建snapshot接口會(huì)返回id "destination_type":"volume" } ], "flavorRef":"s3.xlarge.2", "max_count":1, "min_count":1, "networks": [ { "uuid":"79a68cef-0936-4e21-b1f4-b800ecb70246" } ] } }
  • 通過(guò)block_device_mapping_v2使用卷創(chuàng)建一臺(tái)彈性云服務(wù)器。POST https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/servers { "server": { "flavorRef": "2", "name": "wjvm48", "metadata": { "name": "name_xx1", "id": "id_xxxx1" }, "block_device_mapping_v2": [{ "source_type": "volume", "destination_type": "volume", "uuid": "bd7e4f86-b004-4745-bea2-a55b1085f107", "delete_on_termination": "False", "boot_index": "0", "volume_type": "dsware", "volume_size": "40" }], "security_groups": [{ "name": "name_xx5_sg" }], "networks": [{ "uuid": "fd40e6f8-942d-4b4e-a7ae-465287b02a2c", "port": "e730a11c-1a19-49cc-8797-cee2ad67af6f", "fixed_ip": "10.20.30.137" }], "key_name": "test", "user_data": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1
  • 使用imageRef創(chuàng)建一臺(tái)彈性云服務(wù)器。POST https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/servers { "server": { "flavorRef": "2", "name": "wjvm48", "metadata": { "name": "name_xx1", "id": "id_xxxx1" }, "adminPass": "name_xx1", "imageRef": "6b344c54-d606-4e1a-a99e-a7d0250c3d14", "security_groups": [{ "name": "name_xx5_sg" }], "networks": [{ "uuid": "fd40e6f8-942d-4b4e-a7ae-465287b02a2c", "port": "e730a11c-1a19-49cc-8797-cee2ad67af6f", "fixed_ip": "10.20.30.137" }], "key_name": "test", "user_data": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN
  • 批量創(chuàng)建彈性云服務(wù)器,最小數(shù)量為2,最大數(shù)量為3。POST https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/servers { "server": { "availability_zone":"az1.dc1", "name": "test", "imageRef": "10ff4f01-35b6-4209-8397-359cb4475fa0", "flavorRef": "s3.medium", "return_reservation_id": "true", "networks": [ { "uuid": "51bead38-d1a3-4d08-be20-0970c24b7cab" } ], "min_count": "2", "max_count": "3" } }

響應(yīng)示例

創(chuàng)建彈性云服務(wù)器:

{ "server": { "security_groups": [ { "name": "name_xx5_sg" } ], "OS-DCF:diskConfig": " MANUAL", "id": "567c1557-0eca-422c-bfce-149d6b8f1bb8", "links": [ { "href": "http://xxx/v2/dc4059e8e7994f2498b514ca04cdaf44/servers/567c1557-0eca-422c-bfce-149d6b8f1bb8", "rel": "self" }, { "href": "http://xxx/dc4059e8e7994f2498b514ca04cdaf44/servers/567c1557-0eca-422c-bfce-149d6b8f1bb8", "rel": "bookmark" } ], "adminPass": "name_xx1" } }

批量創(chuàng)建彈性云服務(wù)器:

{ "reservation_id": "r-3fhpjulh" }

返回值

請(qǐng)參考通用請(qǐng)求返回值