数据类型

server(云服务器参数)

名称 类型 是否必须 描述
imageRef String 是 待创建云服务器的系统镜像，需要指定已创建镜像的ID，ID格式为通用唯一识别码（Universally Unique Identifier，简称UUID）。
flavorRef String 是 待创建云服务器的系统规格的ID 有效值：
S1.medium.2,S1.medium.4,S1.large.1,S1.large.2,S1.large.4
S1.xlarge.1,S1.xlarge.2,S1.xlarge.4
S1.2xlarge.1,S1.2xlarge.2,S1.2xlarge.4
S1.4xlarge.1,S1.4xlarge.2,S1.4xlarge.4
S1.8xlarge.1,S1.8xlarge.2,S1.8xlarge.4
S1.null
vcpus Integer 否 当创建模式为高级模式时触发。
虚拟CPU核数。单位：个。
范围：[1-32]，默认为4。
ram Integer 否 当创建模式为高级模式时触发。
内存大小。单位：GiB。范围 ：[1-128]，内存上限为为CPU的8倍，默认为5。
name String 是 云服务器名称。 取值范围：
长度为2-128个字符，不能以特殊字符及数字开头，只可包含特殊字符中的"."，"_"或"-"
nameSuffix String 否 实例名称后缀，name参数如果缺省，此参数不生效；当大于1台的批量创建主机，后缀编号自动+1，例如后缀输入5，主机名输入"host"，批量3台，则生成的三台主机名分别为："host-5"、"host-6"、"host-7"
有效值：0到9999
adminPass String 否 如果需要使用密码方式登录云服务器，可使用adminPass字段指定云服务器管理员帐户初始登录密码。其中，Linux管理员帐户为root，Windows管理员帐户为Administrator。
有效值：8-32个字符，必须包含大小写字母和数字，支持英文特殊字符!"$%()*+,-./:;\<=>?\@[]\^_`{|}~
key_name String 否 密钥名称
networks 网络接口（network)列表 是 云服务器网络信息。
eip 公网IP（eip)列表 否 配置云服务器的弹性IP信息，弹性IP有两种配置方式。
  • 不使用（无该字段）
  • 自动分配，需要指定新创建弹性IP的信息
count Integer 否 创建云服务器数量。 约束：
  • 不传该字段时默认取值为1。
  • 租户的配额足够时，最大值为200。
root_volume 根设备（root）列表 是 云服务器对应系统盘相关配置。
data_volumes 数据盘(data_volume）列表 否 云服务器对应数据盘相关配置。每一个数据结构代表一块待创建的数据盘。
约束：目前新创建的弹性云服务器最多可挂载23块数据盘。
security_groups 安全组（security_group）列表 是 云服务器对应安全组信息。
约束：当该值指定为空时，默认给云服务器绑定default安全组。
availability_zone String 是 待创建云服务器所在的可用分区，需要指定可用分区（AZ）的名称。
chargetype String 否 实例的计费方式，取值范围： PrePaid：预付费，即包年包月。此时，您必须确认自己的账号支持余额支付或者信用支付。PostPaid：按量付费。默认值：PrePaid
purchasetime String 否 购买时长，单位月 有效值：当计费类型为PrePaid（包年包月）时，有效值1-36；其他计费类型时，强制要求参数值为0

server(返回)

名称 类型 是否必须 描述
imageRef String 是 待创建云服务器的系统镜像，需要指定已创建镜像的ID，ID格式为通用唯一识别码（Universally Unique Identifier，简称UUID）。
flavorRef String 是 待创建云服务器的系统规格的ID 有效值：
S1.medium.2,S1.medium.4,S1.large.1,S1.large.2,S1.large.4
S1.xlarge.1,S1.xlarge.2,S1.xlarge.4
S1.2xlarge.1,S1.2xlarge.2,S1.2xlarge.4
S1.4xlarge.1,S1.4xlarge.2,S1.4xlarge.4
S1.8xlarge.1,S1.8xlarge.2,S1.8xlarge.4
S1.null
vcpus Integer 否 当创建模式为高级模式时触发。
虚拟CPU核数。单位：个。
范围：[1-32]，默认为4。
ram Integer 否 当创建模式为高级模式时触发。 内存大小。单位：GiB。范围 ：[1-128]，内存上限为为CPU的8倍，默认为5。
name String 是 云服务器名称。
取值范围：
长度为2-128个字符，不能以特殊字符及数字开头，只可包含特殊字符中的"."，"_"或"-"
nameSuffix String 否 实例名称后缀，name参数如果缺省，此参数不生效；当大于1台的批量创建主机，后缀编号自动+1，例如后缀输入5，主机名输入"host"，批量3台，则生成的三台主机名分别为："host-5"、"host-6"、"host-7"
有效值：0到9999
adminPass String 否 如果需要使用密码方式登录云服务器，可使用adminPass字段指定云服务器管理员帐户初始登录密码。其中，Linux管理员帐户为root，Windows管理员帐户为Administrator。
有效值：8-32个字符，必须包含大小写字母和数字，支持英文特殊字符!"$%()*+,-./:;\<=>?\@[]\^_`{\|}~
key_name String 否 密钥名称
networks 网络接口（network）列表 是 云服务器网络信息。
eip 公网IP（eip）列表 否 配置云服务器的弹性IP信息，弹性IP有两种配置方式。
  • 不使用（无该字段）
  • 自动分配，需要指定新创建弹性IP的信息
count Integer 否 创建云服务器数量。
约束：
  • 不传该字段时默认取值为1。
  • 租户的配额足够时，最大值为200。
root_volume 根设备（root）列表 是 云服务器对应系统盘相关配置。
data_volumes 数据盘(data_volume）列表 否 云服务器对应数据盘相关配置。每一个数据结构代表一块待创建的数据盘。
约束：目前新创建的弹性云服务器最多可挂载23块数据盘。
security_groups 安全组（security_group）)列表 是 云服务器对应安全组信息。
约束：当该值指定为空时，默认给云服务器绑定default安全组。
availability_zone String 是 待创建云服务器所在的可用分区，需要指定可用分区（AZ）的名称。
chargetype String 否 实例的计费方式，取值范围：
  • PrePaid：预付费，即包年包月。此时，您必须确认自己的账号支持余额支付或者信用支付。
  • PostPaid：按量付费。

默认值：PrePaid
purchasetime String 否 购买时长，单位月 有效值：当计费类型为PrePaid（包年包月）时，有效值1-36；其他计费类型时，强制要求参数值为0

networks(网络接口列表)

描述一个网络接口的信息。

名称 类型 是否必须 描述
vpcid String 是 待创建云服务器所属虚拟私有云（简称VPC），需要指定已创建VPC的ID，UUID格式。
subnet_id String 是 待创建云服务器的网卡信息。 需要指定vpcid对应VPC下已创建的网络（network）的ID，UUID格式。
fixed_ip String 是 待创建云服务器网卡的IP地址，IPv4格式。

eip(弹性IP列表)

描述一个弹性公网IP的信息。

名称 类型 是否必须 描述
iptype String 是 弹性IP线路类型。
类型枚举值：
  • 5_bgp：全动态BGP
  • 5_sbgp：静态BGP
  • 5_telcom：中国电信
  • 5_union：中国联通

…
bandwidth Integer 否 带宽（Mbps），取值范围为[1,2000]。
当chrgemode为ShareBandwidth，此参数可忽略。
chargemode String 否 弹性IP的计费方式。
枚举值:
  • "Bandwidth", 带宽计费;
  • "ShareBandwidth",共享带宽模式;

默认为"Bandwidth"。
ShareBandwidthId String 否 绑定的共享带宽Id，仅当chargemode为ShareBandwidth时有效
eipId String 否 弹性IP的ID

root_volume (系统盘列表)

描述云服务器系统盘的信息。

名称 类型 是否必须 描述
volume_type String 否 云服务器系统盘对应的磁盘类型，需要与系统所提供的磁盘类型相匹配。
SATA：普通IO磁盘类型。
size String 是 系统盘大小，容量单位为GiB， 输入大小范围为[40,500]。
约束：
系统盘大小取值应不小于镜像支持的系统盘的最小值(镜像的min_disk属性)。
若该参数没有指定或者指定为0，系统盘大小默认取值为镜像中系统盘的最小值(镜像的min_disk属性)。

data_volume (数据盘列表)

描述云服务器系统盘的信息。

名称 类型 是否必须 描述
volume_type String 否 云服务器系统盘对应的磁盘类型，需要与系统所提供的磁盘类型相匹配。
SATA：普通IO磁盘类型。
size String 是 数据盘大小，容量单位为GiB，输入大小范围为[10,32768]。

security_group (安全组列表)

描述一个安全组信息。

名称 类型 是否必须 描述
name String 是 安全组名称。

os_start数据结构

描述os_start的数据结构。

名称 类型 是否必须 描述
servers Servers列表 是 云服务器ID列表。

os_stop数据结构

描述os_stop的数据结构。

名称 类型 是否必须 描述
servers Servers列表 是 云服务器ID列表。
type String 否 关机类型，默认为SOFT：
SOFT：普通关机（默认）。
HARD：强制关机。

reboot数据结构（批量）

描述批量reboot的数据结构。

名称 类型 是否必须 描述
type String 否 重启类型，默认为SOFT： SOFT：普通重启（默认）。 HARD：强制重启。
servers Servers列表 是 云服务器ID列表。

Servers列表

名称 类型 是否必须 描述
id string 是 云服务器ID。

List_Servers列表

名称 类型 是否必须 描述
name String 是 云服务器名称。
id string 是 云服务器ID。
links Links数据结构列表 是 云服务器相关快捷链接信息。
servers_links Links数据结构列表 否 指向下一个服务器链接，当可显示的云服务器超过limit限制时可用。

Links列表

名称 类型 是否必须 描述
rel String 是 快捷链接标记名称。
href string 是 对应快捷链接。

resize列表

名称 类型 是否必须 描述
flavorRef String 是 待创建云服务器的系统规格的ID 有效值：
S1.medium.2,S1.medium.4,S1.large.1,S1.large.2,S1.large.4
S1.xlarge.1,S1.xlarge.2,S1.xlarge.4
S1.2xlarge.1,S1.2xlarge.2,S1.2xlarge.4
S1.4xlarge.1,S1.4xlarge.2,S1.4xlarge.4
S1.8xlarge.1,S1.8xlarge.2,S1.8xlarge.4
S1.null
如果flavorRef=S1.null，vCPU和Memory参数生效；反之这两个参数不生效。
vcpus Integer 否 当创建模式为高级模式时触发。
虚拟CPU核数。单位：个。
范围：[1-32]，默认为4。
ram Integer 否 当创建模式为高级模式时触发。
内存大小。单位：GiB。范围 ：[1-128]，内存上限为为CPU的8倍，默认为5。