基本信息

Action

RunInstances

Path

/iaas

Method

POST

请求参数

参数名 类型 描述 是否必须

image_id

String

镜像ID，此镜像将作为云服务器的模板。可传青云提供的镜像ID，或自己创建的镜像ID

是

instance_type

String

云服务器类型

  • 如果使用弹性裸金属服务器, 该参数必填。

  • 如果请求中指定了 instance_type，cpu 和 memory 参数可略过。

  • 如果请求中没有 instance_type，则 cpu 和 memory 参数必须指定。

  • 如果请求参数中既有 instance_type，又有 cpu 和 memory，则以 cpu, memory 的值为准。

否

cpu

Integer

CPU core，有效值为: 1, 2, 4, 8, 16

否

memory

Integer

内存，有效值为: 1024, 2048, 4096, 6144, 8192, 12288, 16384, 24576, 32768

否

os_disk_size

Integer

系统盘大小，单位GB。

  • Linux操作系统的有效值为：20-100，默认值为：20

  • Windows操作系统的有效值为：50-100，默认值为：50

否

count

Integer

创建云服务器的数量，默认是1
注解
当同时创建多台云服务器时，这些云服务器的基本信息和配置都是相同的

否

instance_name

String

云服务器名称

否

login_mode

String

指定登录方式。当为 linux 云服务器时，有效值为 keypair 和 passwd; 当为 windows 云服务器时，只能选用 passwd 登录方式。

  • 当登录方式为 keypair 时，需要指定 login_keypair 参数；

  • 当登录方式为 passwd 时，需要指定 login_passwd 参数。

是

login_keypair

String

登录密钥 ID。

否

login_passwd

String

登录密码。

否

vxnets.n

String

云服务器要加入的私有网络ID，如果不传此参数，则表示不加入到任何网络。
如果是自建的受管私有网络 不包括基础网络 vxnet-0 ，则可以在创建云服务器时指定内网IP， 这时参数值要改为 vxnet-id|ip-address ，如 vxnet-abcd123|192.168.1.2 。

否

security_group

String

云服务器加载的防火墙ID，只有在 vxnets.n 包含基础网络 即：vxnet-0 时才需要提供。 若未提供，则默认加载缺省防火墙

否

volumes.n

String

云服务器创建后自动加载的硬盘ID，如果传此参数，则参数 count 必须为1 。

否

hostname

String

可指定云服务器的 hostname 。

否

need_newsid

Integer

1: 生成新的SID，0: 不生成新的SID, 默认为0；只对Windows类型云服务器有效。

否

instance_class

Integer

云服务器性能类型: 性能型:0, 超高性能型:1, 基础型:101, 企业型:201

否

cpu_model

String

CPU 指令集, 有效值: Westmere, SandyBridge, IvyBridge, Haswell, Broadwell

否

cpu_topology

String

CPU 拓扑结构: 插槽数, 核心数, 线程数; 插槽数 * 核心数 * 线程数 应等于您应选择的CPU数量。

否

gpu

Integer

GPU 个数

否

gpu_class

Integer

GPU 类型，有效值有 0 和 1 。0 对应的是 NVIDIA P100，1 对应的是 AMD S7150

否

nic_mqueue

Integer

网卡多对列: 关闭(默认)：0，开启：1

否

need_userdata

Integer

1: 使用 User Data 功能；0: 不使用 User Data 功能；默认为 0 。

否

userdata_type

String

User Data 类型，有效值：plain, exec 或 tar。为 plain或 exec 时，使用一个 Base64 编码后的字符串；为 tar 时，使用一个压缩包 种类为 zip，tar，tgz，tbz 。

否

userdata_value

String

User Data 值。当类型为 plain 时，为字符串的 Base64 编码值，长度限制 4K；当类型为 tar，为调用 UploadUserDataAttachment 返回的 attachment_id。

否

userdata_path

String

User Data 和 MetaData 生成文件的存放路径。不输入或输入不合法时，为默认目录 /etc/qingcloud/userdata

否

userdata_file

String

userdata_type 为 ‘exec’ 时，指定生成可执行文件的路径，默认为/etc/rc.local

否

target_user

String

目标用户 ID ，可用于主账号为其子账号创建资源。

否

dedicated_host_group_id

String

虚机创建到指定的专属宿云服务器组中

否

dedicated_host_id

String

虚机创建到某专属宿云服务器组中指定的宿云服务器上

否

instance_group

String

虚机创建加入到指定的云服务器组中

否

hypervisor

String

hypervisor 类型，当前支持 kvm 和 bm, 默认是 kvm

否

os_disk_encryption

Boolean

创建加密云服务器

否

cipher_alg

String

加密使用的算法类型:
目前仅支持 aes256，默认 aes256

否

months

Integer

如果购买合约模式的云服务器，需要传此参数，数值为购买的月份数。

否

auto_renew

Integer

如果购买合约模式的云服务器，可传此参数，数值为合约到期后自动续约的月份数。如果购买合约时不传此参数，合约到期则不会自动续约。

否

返回数据

此接口除公共返回参数外，还包含以下返回参数。关于公共返回参数的更多信息，请参见前文内容。

参数名 类型 描述

instances

Array

创建的云服务器 ID 列表

请求示例

https://api.<your_domain>/iaas/?action=RunInstances
&vxnets.1=vxnet-0
&instance_type=small_a
&image_id=centos63x64
&COMMON_PARAMS

返回示例

{
  "action":"RunInstancesResponse",
  "instances":[
    "i-rtyv0968"
  ],
  "job_id":"j-bm6ym3r8",
  "ret_code":0
}