文档首页/ 弹性云服务器 ECS/ API参考（吉隆坡区域）/ 数据结构/ 数据结构(创建云服务器)
更新时间：2024-04-18 GMT+08:00
查看PDF
分享

数据结构(创建云服务器)

数据结构导航

publicip字段数据结构说明

该字段被如下接口使用
  • 创建云服务器 /v1/{project_id}/cloudservers
表1 publicip字段数据结构说明

参数

是否必选

参数类型

描述

id

否

String

为待创建云服务器分配已有弹性公网IP时，分配的弹性公网IP的ID，UUID格式。

约束：只能分配状态（status）为DOWN的弹性公网IP。

eip

否

Object

配置云服务器自动分配弹性公网IP时，创建弹性公网IP的配置参数。

详情请参见表3。

delete_on_termination

否

Boolean

弹性公网IP随实例释放策略。

  • true：弹性公网IP随实例释放。
  • false：弹性公网IP不随实例释放。

默认值：false。

输入publicip字段数据结构中的id和eip的值时，只能选择其中一个参数值输入。

security_groups字段数据结构说明

该字段被如下接口使用

  • 创建云服务器 /v1/{project_id}/cloudservers
表2 security_groups字段数据结构说明

参数

是否必选

参数类型

描述

id

否

String

待创建云服务器的安全组，会对创建云服务器中配置的网卡生效。需要指定已有安全组的ID，UUID格式；若不传id字段，底层会创建默认安全组。

eip字段数据结构说明

该字段被如下接口使用
  • 创建云服务器 /v1/{project_id}/cloudservers
表3 eip字段数据结构说明

参数

是否必选

参数类型

描述

iptype

是

String

弹性公网IP地址类型。

类型枚举值，请参见《虚拟私有云接口参考》“申请弹性公网IP”章节的“publicip”字段说明。

bandwidth

是

Object

弹性公网IP地址带宽参数。

详情请参见bandwidth字段数据结构说明。

bandwidth字段数据结构说明

该字段被如下接口使用
  • 创建云服务器 /v1/{project_id}/cloudservers
表4 bandwidth字段数据结构说明

参数

是否必选

参数类型

描述

size

是

Integer

功能说明：带宽大小

带宽（Mbit/s），取值范围为[1,300]。

具体范围以各区域配置为准，请参见控制台对应页面显示。

调整带宽时的最小单位会根据带宽范围不同存在差异。
  • 小于等于300Mbit/s：默认最小单位为1Mbit/s。
  • 300Mbit/s~1000Mbit/s：默认最小单位为50Mbit/s。
  • 大于1000Mbit/s：默认最小单位为500Mbit/s。
说明：

如果share_type是PER，该参数必选项；如果share_type是WHOLE并且id有值，该参数会忽略。

sharetype

是

String

带宽的共享类型。

共享类型枚举：PER，表示独享。WHOLE，表示共享。

chargemode

否

String

带宽的计费类型。

  • 字段值为“traffic”，表示按流量计费。
  • 字段为其它值，会导致创建云服务器失败。

ipv6_bandwidth字段数据结构说明

该字段被如下接口使用
  • 创建云服务器 /v1/{project_id}/cloudservers
表5 ipv6_bandwidth字段数据结构说明

参数

是否必选

参数类型

描述

id

否

String

IPv6带宽的ID。

创建磁盘的extendparam字段数据结构说明

该字段被如下接口使用：

  • 创建云服务器 /v1/{project_id}/cloudservers
表6 创建磁盘的extendparam字段数据结构说明

参数

是否必选

参数类型

描述

resourceSpecCode

否

String

磁盘产品资源规格编码，如SATA，SAS和SSD。

说明：

废弃字段。

resourceType

否

String

磁盘产品资源类型。

说明：

废弃字段。

snapshotId

否

String

整机镜像中自带的原始数据盘（简称“原数据盘”）所对应的快照ID或原始数据盘ID。

使用场景：

使用整机镜像创建云服务器，并且选择的整机镜像自带1个或者多个数据盘。

使用整机镜像创建云服务器时，系统会自动恢复整机镜像中自带的数据盘（包括数据盘类型和数据）。此时，您可以通过snapshotId，修改指定原数据盘恢复后的磁盘类型。

说明：
  • 建议对每块原数据盘都指定snapshotId。
  • 如需修改磁盘大小，修改后的磁盘大小需大于等于原数据盘大小。否则，会影响原数据盘的数据恢复。
  • 如需设置磁盘共享，需指定共享属性。
  • 如需设置磁盘加密，需在metadata字段指定相关加密属性。

实现原理：

snapshotId是整机镜像自带原始数据盘的唯一标识，通过snapshotId可以获取原数据盘的磁盘信息，从而恢复数据盘数据。

通过管理控制台获取snapshotId：

登录管理控制台，打开"云硬盘 > 快照"页面，根据原始数据盘的磁盘名称找到对应的快照ID或者原始数据盘的ID。

通过API查询snapshotId：

已知整机镜像ID，参考镜像服务的“查询镜像详情”接口获取整机镜像ID关联的云备份或云服务器备份ID。
  • 如果使用的是云备份，请使用云备份ID查询备份信息，响应信息children字段中包含的resource_id或snapshot_id即为所需的snapshotId。详细操作请参考云备份服务“查询指定备份”接口。
  • 如果使用的是云服务器备份，请使用云服务器备份ID查询备份信息，响应信息volume_backups字段中包含的source_volume_id或snapshot_id即为所需的snapshotId。详细操作请参考云服务器备份“查询单个备份”接口。

创建云服务器的extendparam字段数据结构说明

该字段被如下接口使用：
  • 创建云服务器 /v1/{project_id}/cloudservers
表7 创建云服务器的extendparam字段数据结构说明（适用V1接口）

参数

是否必选

参数类型

描述

regionID

否

String

云服务器所在区域ID。

创建磁盘的metadata字段数据结构说明

该字段被如下接口使用：

  • 创建云服务器 /v1/{project_id}/cloudservers
表8 创建磁盘的metadata字段数据结构说明

参数

是否必选

参数类型

描述

__system__encrypted

否

String

metadata中的表示加密功能的字段，0代表不加密，1代表加密。

该字段不存在时，云硬盘默认为不加密。

__system__cmkid

否

String

用户主密钥ID，是metadata中的表示加密功能的字段，与__system__encrypted配合使用。

说明：

参考《密钥管理服务API参考》中的“查询密钥列表”章节通过HTTPS请求获取密钥ID。

创建云服务器的metadata字段数据结构说明

该字段被如下接口使用：

  • 创建云服务器 /v1/{project_id}/cloudservers
表9 metadata预留字段数据结构说明

参数

是否必选

参数类型

描述

op_svc_userid

否

String

用户ID。

agency_name

否

String

委托的名称。

委托是由租户管理员在统一身份认证服务（Identity and Access Management，IAM）上创建的，可以为弹性云服务器提供访问云服务的临时凭证。

os:scheduler_hints字段数据结构说明

该字段被如下接口使用：
  • 创建云服务器 /v1/{project_id}/cloudservers
  • 创建云服务器(原生) /v2.1/{project_id}/servers
表10 os:scheduler_hints字段数据结构说明（请求参数）

参数

是否必选

参数类型

描述

group

否

String

云服务器组ID，UUID格式。

云服务器组的ID可以从控制台或者参考查询云服务器组列表获取。

说明：

请确保云服务器组使用的是反亲和性anti-affinity策略，不推荐使用其他策略。
表11 os:scheduler_hints字段数据结构说明（响应参数）

参数

参数类型

描述

group

Array of strings

云服务器组ID，UUID格式。

云服务器组的ID可以从控制台或者参考查询云服务器组列表获取。

server_tags字段数据结构说明

该字段被如下接口使用：
  • 创建云服务器 /v1/{project_id}/cloudservers
表12 server_tags字段数据结构说明

参数

是否必选

参数类型

描述

key

是

String

键。

最大长度36个unicode字符。key不能为空。不能包含非打印字符ASCII(0-31)，"=", "*",“<”,“>”,“\”,“,”,“|”,“/”。

同一资源的key值不能重复。

value

是

String

值。

每个值最大长度43个unicode字符，可以为空字符串。 不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”。
父主题： 数据结构