数据结构(创建云服务器)-九游平台
使用须知
自研的创建云服务器接口支持有v1和v1.1两个版本,其中v1只能创建按需的云服务器,v1.1可以创建按需和包年/包月虚拟机。
下面数据结构中的字段,当选择包年/包月计费模式时(包年包月的),请选择使用v1.1的创建云服务器接口。
数据结构导航
publicip字段数据结构说明
- 创建云服务器 /v1/{project_id}/cloudservers
- 创建云服务器 /v1.1/{project_id}/cloudservers
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
string |
为待创建云服务器分配已有弹性公网ip时,分配的弹性公网ip的id,uuid格式。 约束:只能分配状态(status)为down的弹性公网ip。 |
eip |
否 |
object |
配置云服务器自动分配弹性公网ip时,创建弹性公网ip的配置参数。 详情请参见表3。 |
delete_on_termination |
否 |
boolean |
弹性公网ip随实例释放策略。
默认值:false。
说明:
该字段仅按需弹性公网ip支持。 |

输入publicip字段数据结构中的id和eip的值时,只能选择其中一个参数值输入。
security_groups字段数据结构说明
该字段被如下接口使用
- 创建云服务器 /v1/{project_id}/cloudservers
- 创建云服务器 /v1.1/{project_id}/cloudservers
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
string |
待创建云服务器的安全组,会对创建云服务器中配置的网卡生效。需要指定已有安全组的id,uuid格式;若不传id字段,底层会创建默认安全组。 |
eip字段数据结构说明
- 创建云服务器 /v1/{project_id}/cloudservers
- 创建云服务器 /v1.1/{project_id}/cloudservers
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
iptype |
是 |
string |
弹性公网ip地址类型。 详情请参见“”章节的“publicip”字段说明。 |
bandwidth |
是 |
object |
弹性公网ip地址带宽参数。 详情请参见bandwidth字段数据结构说明。 |
extendparam |
否 |
object |
创建弹性公网ip的附加信息。 详情请参见表6
说明:
当创建云服务器的extendparam结构中chargingmode为prepaid时(即创建包年包月付费的云服务器),若需要创建按需计费的弹性ip,该字段必选,需要在该结构中增加chargingmode为postpaid(按需付费)。 |
bandwidth字段数据结构说明
- 创建云服务器 /v1/{project_id}/cloudservers
- 创建云服务器 /v1.1/{project_id}/cloudservers
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
size |
否 |
integer |
功能说明:带宽大小 带宽(mbit/s),取值范围为[1,2000]。 具体范围以各区域配置为准,请参见控制台对应页面显示。
调整带宽时的最小单位会根据带宽范围不同存在差异。
说明:
如果share_type是per,该参数必选项;如果share_type是whole并且id有值,该参数会忽略。 |
sharetype |
是 |
string |
带宽的共享类型。 共享类型枚举:per,表示独享。whole,表示共享。 |
chargemode |
否 |
string |
带宽的计费类型。
|
id |
否 |
string |
带宽id,创建whole类型带宽的弹性ip时可以指定之前的共享带宽创建。 取值范围:whole类型的带宽id。
说明:
当创建whole类型的带宽时,该字段必选。 |
ipv6_bandwidth字段数据结构说明
- 创建云服务器 /v1/{project_id}/cloudservers
- 创建云服务器 /v1.1/{project_id}/cloudservers
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
string |
ipv6带宽的id。 |
创建弹性公网ip的extendparam字段数据结构说明
该字段被如下接口使用:
创建云服务器 /v1.1/{project_id}/cloudservers
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
chargingmode |
否 |
string |
公网ip的计费模式。 取值范围:
|
创建磁盘的extendparam字段数据结构说明
该字段被如下接口使用:
- 创建云服务器 /v1/{project_id}/cloudservers
- 创建云服务器 /v1.1/{project_id}/cloudservers
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
resourcespeccode |
否 |
string |
磁盘产品资源规格编码,如sata,sas和ssd。
说明:
废弃字段。 |
resourcetype |
否 |
string |
磁盘产品资源类型。
说明:
废弃字段。 |
snapshotid |
否 |
string |
整机镜像中自带的原始数据盘(简称“原数据盘”)所对应的快照id或原始数据盘id。 使用场景: 使用整机镜像创建云服务器,并且选择的整机镜像自带1个或者多个数据盘。 使用整机镜像创建云服务器时,系统会自动恢复整机镜像中自带的数据盘(包括数据盘类型和数据)。此时,您可以通过snapshotid,修改指定原数据盘恢复后的磁盘类型。
说明:
实现原理: snapshotid是整机镜像自带原始数据盘的唯一标识,通过snapshotid可以获取原数据盘的磁盘信息,从而恢复数据盘数据。 通过管理控制台获取snapshotid: 登录管理控制台,打开"云硬盘 > 快照"页面,根据原始数据盘的磁盘名称找到对应的快照id或者原始数据盘的id。 通过api查询snapshotid:
已知整机镜像id,参考镜像服务的“查询镜像详情”接口获取整机镜像id关联的云备份或云服务器备份id。
|
创建云服务器的extendparam字段数据结构说明
- 创建云服务器 /v1/{project_id}/cloudservers
- 创建云服务器 /v1.1/{project_id}/cloudservers
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
chargingmode |
否 |
integer |
计费模式:
|
regionid |
否 |
string |
云服务器所在区域id。 请参考获取。 |
support_auto_recovery |
否 |
boolean |
是否配置云服务器自动恢复的功能。
说明:
此参数为boolean类型,若传入非boolean类型字符,程序将按照“false”:不配置该功能的方式处理。
"cond:compute": autorecovery可通过查询。 |
enterprise_project_id |
否 |
string |
企业项目id。
说明:
关于企业项目id的获取及企业项目特性的详细信息,请参见《企业管理服务用户指南》。 该字段不传(或传为字符串“0”),则将资源绑定给默认企业项目。 |
markettype |
否 |
string |
创建竞价实例时,需指定该参数的值为“spot”。
说明:
当chargingmode=0时且markettype=spot时此参数生效。 |
spotprice |
否 |
string |
用户愿意为竞价实例每小时支付的最高价格。
说明:
|
diskprior |
否 |
string |
是否支持先创建卷,再创建虚拟机。
|
spot_duration_hours |
否 |
integer |
购买的竞价实例时长。
说明:
|
spot_duration_count |
否 |
integer |
表示购买的“竞价实例时长”的个数。
说明:
|
interruption_policy |
否 |
string |
竞价实例中断策略,当前支持immediate(立即释放)。
说明:
当实例为竞享模式时,必须设置为immediate |
cb_csbs_backup |
否 |
string |
云备份策略和云备份存储库详情,取值包含备份策略id和云备份存储库id。 例如:在控制台查询备份策略id为:fdcaa27d-5be4-4f61-afe3-09ff79162c04 云备份存储库id为:332a9408-463f-436a-9e92-78dad95d1ac4 则cb_csbs_backup取值为:"{\"policy_id\":\"fdcaa27d-5be4-4f61-afe3-09ff79162c04\",\"vault_id\":\"332a9408-463f-436a-9e92-78dad95d1ac4\"}" |
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
chargingmode |
否 |
string |
计费模式。 功能说明:付费方式 取值范围:
|
regionid |
否 |
string |
云服务器所在区域id。 请参考获取。 |
periodtype |
否 |
string |
订购周期类型。 取值范围:
|
periodnum |
否 |
integer |
订购周期数。 取值范围:
说明:
|
isautorenew |
否 |
string |
是否自动续订。
|
isautopay |
否 |
string |
下单订购后,是否自动从客户的账户中支付,而不需要客户手动去进行支付。
说明:
chargingmode为prepaid时生效,不传该字段时默认为客户手动支付。 |
enterprise_project_id |
否 |
string |
企业项目id。
说明:
关于企业项目id的获取及企业项目特性的详细信息,请参见《企业管理服务用户指南》。 该字段不传(或传为字符串“0”),则将资源绑定给默认企业项目。 |
support_auto_recovery |
否 |
boolean |
是否配置虚拟机自动恢复的功能。
说明:
此参数为boolean类型,若传入非boolean类型字符,程序将按照【“false”:不配置该功能】方式处理。 当markettype为spot时,不支持该功能。 |
markettype |
否 |
string |
创建竞价实例时,需指定该参数的值为“spot”。
说明:
当chargingmode=postpaid且markettype=spot时,此参数生效。 |
spotprice |
否 |
string |
用户愿意为竞价云服务器每小时支付的最高价格。
说明:
|
diskprior |
否 |
string |
是否支持先创建卷,再创建虚拟机。
|
spot_duration_hours |
否 |
integer |
购买的竞价实例时长。
说明:
|
spot_duration_count |
否 |
integer |
表示购买的“竞价实例时长”的个数。
说明:
|
interruption_policy |
否 |
string |
竞价实例中断策略,当前支持immediate(立即释放)。
说明:
当实例为竞享模式时,必须设置为immediate |
cb_csbs_backup |
否 |
string |
云备份策略和云备份存储库详情,取值包含备份策略id和云备份存储库id。 例如:在控制台查询备份策略id为:fdcaa27d-5be4-4f61-afe3-09ff79162c04 云备份存储库id为:332a9408-463f-436a-9e92-78dad95d1ac4 则cb_csbs_backup取值为:"{\"policy_id\":\"fdcaa27d-5be4-4f61-afe3-09ff79162c04\",\"vault_id\":\"332a9408-463f-436a-9e92-78dad95d1ac4\"}" |
创建磁盘的metadata字段数据结构说明
该字段被如下接口使用:
- 创建云服务器 /v1/{project_id}/cloudservers
- 创建云服务器 /v1.1/{project_id}/cloudservers

- 创建云服务器时,root_volume和data_volume都包含metadata字段。
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
__system__encrypted |
否 |
string |
metadata中的表示加密功能的字段,0代表不加密,1代表加密。 该字段不存在时,云硬盘默认为不加密。 |
__system__cmkid |
否 |
string |
用户主密钥id,是metadata中的表示加密功能的字段,与__system__encrypted配合使用。
说明:
请参考,通过https请求获取密钥id。 |
创建云服务器的metadata字段数据结构说明
该字段被如下接口使用:
- 创建云服务器 /v1/{project_id}/cloudservers
- 创建云服务器 /v1.1/{project_id}/cloudservers
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
op_svc_userid |
否 |
string |
用户id。 您可以在下,通过“api凭证”页面的“iam用户id”,获取该参数的值。更多内容,请参见api凭证。
说明:
该参数取值为当前登录账号的“iam用户id”,如果您当前使用iam用户登录,则需要获取对应iam用户的“iam用户id”。 |
agency_name |
否 |
string |
委托的名称。 委托是由租户管理员在统一身份认证服务(identity and access management,iam)上创建的,可以为弹性云服务器提供访问云服务的临时凭证。
说明:
委托获取、更新请参考如下步骤:
|
__support_agent_list |
否 |
string |
云服务器是否支持主机安全服务、主机监控。
取值样例: __support_agent_list:“hss,ces” 可以通过查询镜像详情判断创建云服务器使用的镜像是否支持主机安全服务或主机监控。 |
os:scheduler_hints字段数据结构说明
- 创建云服务器 /v1/{project_id}/cloudservers
- 创建云服务器 /v1.1/{project_id}/cloudservers
- 创建云服务器(原生) /v2.1/{project_id}/servers
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
group |
否 |
string |
云服务器组id,uuid格式。 云服务器组的id可以从控制台或者参考查询云服务器组列表获取。
说明:
请确保云服务器组使用的是反亲和性anti-affinity策略,不推荐使用其他策略。 在指定的专属主机上创建的弹性云服务器不支持选择反亲和性anti-affinity策略。 |
tenancy |
否 |
string |
在指定的专属主机或者共享主机上创建弹性云服务器。 参数值为shared或者dedicated。 |
dedicated_host_id |
否 |
string |
专属主机的id。
说明:
专属主机的id仅在tenancy为dedicated时生效。 |
参数 |
参数类型 |
描述 |
---|---|---|
group |
array of strings |
云服务器组id,uuid格式。 云服务器组的id可以从控制台或者参考查询云服务器组列表获取。 |
tenancy |
array of strings |
在指定的专属主机或者共享主机上创建弹性云服务器。 参数值为shared或者dedicated。 |
dedicated_host_id |
array of strings |
专属主机的id。
说明:
专属主机的id仅在tenancy为dedicated时生效。 |
server_tags字段数据结构说明
- 创建云服务器 /v1/{project_id}/cloudservers
- 创建云服务器 /v1.1/{project_id}/cloudservers
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
key |
是 |
string |
键。 最大长度36个unicode字符。key不能为空。不能包含非打印字符ascii(0-31),"=", "*",“<”,“>”,“\”,“,”,“|”,“/”。 同一资源的key值不能重复。 |
value |
是 |
string |
值。 每个值最大长度43个unicode字符,可以为空字符串。 不能包含非打印字符ascii(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”。 |
相关文档
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨