数据结构(创建云服务器)
数据结构导航
publicip字段数据结构说明
- 创建云服务器 /v1/{project_id}/cloudservers
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
否 |
String |
为待创建云服务器分配已有弹性公网IP弹性IP时，分配的弹性公网IP弹性IP的ID，UUID格式。 约束：只能分配状态（status）为DOWN的弹性公网IP弹性IP。 |
|
eip |
否 |
Object |
配置云服务器自动分配弹性公网IP弹性IP时，创建弹性公网IP弹性IP的配置参数。 详情请参见表3。 |
|
delete_on_termination |
否 |
Boolean |
弹性公网IP随实例释放策略。
默认值：false。 |
输入publicip字段数据结构中的id和eip的值时，只能选择其中一个参数值输入。
eip字段数据结构说明
- 创建云服务器 /v1/{project_id}/cloudservers
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
iptype |
是 |
String |
弹性公网IP弹性IP地址类型。 类型枚举值，请参见《虚拟私有云接口参考》“申请弹性公网IP弹性IP”章节的“publicip”字段说明。 |
|
bandwidth |
是 |
Object |
弹性公网IP弹性IP地址带宽参数。 详情请参见bandwidth字段数据结构说明。 |
bandwidth字段数据结构说明
- 创建云服务器 /v1/{project_id}/cloudservers
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
size |
是 |
Integer |
功能说明：带宽大小 带宽（Mbit/s），取值范围为[1,1000]。 具体范围以各区域配置为准，请参见控制台对应页面显示。 |
|
sharetype |
是 |
String |
带宽的共享类型。 共享类型枚举：PER，表示独享。WHOLE，表示共享。 |
|
chargemode |
是 |
String |
带宽的计费类型。
|
创建磁盘的extendparam字段数据结构说明
该字段被如下接口使用：
- 创建云服务器 /v1/{project_id}/cloudservers
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
snapshotId |
否 |
String |
整机镜像中自带的原始数据盘（简称“原数据盘”）所对应的快照ID或原始数据盘ID。 使用场景： 使用整机镜像创建云服务器，并且选择的整机镜像自带1个或者多个数据盘。 使用整机镜像创建云服务器时，系统会自动恢复整机镜像中自带的数据盘（包括数据盘类型和数据）。此时，您可以通过snapshotId，修改指定原数据盘恢复后的磁盘类型。
说明：
实现原理： snapshotId是整机镜像自带原始数据盘的唯一标识，通过snapshotId可以获取原数据盘的磁盘信息，从而恢复数据盘数据。 通过管理控制台获取snapshotId： 登录管理控制台，打开"云硬盘 > 快照"页面，根据原始数据盘的磁盘名称找到对应的快照ID或者原始数据盘的ID。 通过API查询snapshotId：
已知整机镜像ID，参考镜像服务的“查询镜像详情”接口获取整机镜像ID关联的云备份或云服务器备份ID。
|
创建磁盘的metadata字段数据结构说明
该字段被如下接口使用：
- 创建云服务器 /v1/{project_id}/cloudservers
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
__system__encrypted |
否 |
String |
metadata中的表示加密功能的字段，0代表不加密，1代表加密。 该字段不存在时，云硬盘默认为不加密。 |
|
__system__cmkid |
否 |
String |
用户主密钥ID，是metadata中的表示加密功能的字段，与__system__encrypted配合使用。
说明：
参考《密钥管理服务API参考》中的“查询密钥列表”章节通过HTTPS请求获取密钥ID。 |
创建云服务器的metadata字段数据结构说明
该字段被如下接口使用：
- 创建云服务器 /v1/{project_id}/cloudservers
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
admin_pass |
否 |
String |
Windows云服务器Administrator用户的密码，具体使用方法请参见功能介绍。
说明：
创建密码方式鉴权的Windows弹性云服务器时为必选字段。 |
|
op_svc_userid |
否 |
String |
用户ID。 |
|
agency_name |
否 |
String |
委托的名称。 委托是由租户管理员在统一身份认证服务（Identity and Access Management，IAM）上创建的，可以为弹性云服务器提供访问云服务的临时凭证。 |
|
BYOL |
否 |
String |
如果您已拥有操作系统或软件的许可证（一般是指按物理插槽数、物理内核数等进行认证的许可证），您可以通过自带许可（BYOL）的方式将业务完整迁移到云平台，继续使用您的许可证。
|
os:scheduler_hints字段数据结构说明
- 创建云服务器 /v1/{project_id}/cloudservers
- 创建云服务器(原生) /v2.1/{project_id}/servers
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
group |
否 |
String |
云服务器组ID，UUID格式。 云服务器组的ID可以从控制台或者参考查询云服务器组列表获取。
说明：
请确保云服务器组使用的是反亲和性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时生效。 |
