创建实例

最近更新时间:2019-12-04 10:54:43

说明:

当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 云服务器 API 3.0

1. 接口描述

本接口 (RunInstances) 用于创建一个或多个指定配置的实例。
接口请求域名:cvm.api.qcloud.com

  • 实例创建成功后将自动开机启动,实例状态变为“运行中”。
  • 预付费实例的购买会预先扣除本次实例购买所需金额,按小时后付费实例购买会预先冻结本次实例购买一小时内所需金额,在调用本接口前请确保账户余额充足。
  • 本接口允许购买的实例数量遵循 CVM 实例购买限制,所创建的实例和官网入口创建的实例共用配额。
  • 本接口为异步接口,当创建请求下发成功后会返回一个实例ID列表,此时实例的创建并立即未完成。在此期间实例的状态将会处于“准备中”,可以通过调用 DescribeInstancesStatus 接口查询对应实例的状态,来判断生产有没有最终成功。如果实例的状态由“准备中”变为“运行中”,则为创建成功。

2. 输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。

名称 类型 是否必选 描述
Version String 表示API版本号,主要用于标识请求的不同API版本。 本接口第一版本可传:2017-03-12。
InstanceChargeType String 实例 计费类型
  • PREPAID:预付费,即包年包月
  • POSTPAID_BY_HOUR:按小时后付费
    默认值:POSTPAID_BY_HOUR。
  • InstanceChargePrepaid InstanceChargePrepaid object 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
    Placement Placement object 实例所在的位置。通过该参数可以指定实例所属可用区,所属项目等属性。
    InstanceType String 实例机型。不同实例机型指定了不同的资源规格,具体取值可通过调用接口 DescribeInstanceTypeConfigs 来获得最新的规格表或参见 实例类型 描述。若不指定该参数,则默认机型为 S1.SMALL1。
    ImageId String 指定有效的镜像 ID,格式形如img-xxx。镜像类型分为四种:
  • 公共镜像
  • 自定义镜像
  • 共享镜像
  • 服务市场镜像

  • 可通过以下方式获取可用的镜像 ID:
  • 公共镜像自定义镜像共享镜像的镜像ID可通过登录 控制台 查询;服务镜像市场的镜像 ID可通过 云市场 查询。
  • 通过调用接口 DescribeImages,取返回信息中的ImageId字段。
  • SystemDisk SystemDisk object 实例系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
    DataDisks.N array of DataDisk objects 实例数据盘配置信息。若不指定该参数,则默认不购买数据盘,当前仅支持购买的时候指定一个数据盘。
    VirtualPrivateCloud VirtualPrivateCloud object 私有网络相关信息配置。通过该参数可以指定私有网络的 ID,子网 ID 等信息。若不指定该参数,则默认使用基础网络。若在此参数中指定了私有网络 IP,那么InstanceCount参数只能为1。
    InternetAccessible InternetAccessible object 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。
    InstanceCount Integer 购买实例数量。取值范围:[1,100]。默认取值:1。指定购买实例的数量不能超过用户所能购买的剩余配额数量,具体配额相关限制详见 CVM 实例购买限制
    InstanceName String 实例显示名称。如果不指定则默认显示"未命名"。最大长度不能超60个字节。
    LoginSettings LoginSettings object 实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码,并以站内信方式知会到用户。
    SecurityGroupIds.N array of Strings 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的 sgId 字段来获取。若不指定该参数,则默认不绑定安全组。不绑定安全组将暴露所有端口到公网和内网,实例的所有业务(如80、443等端口)将均可被访问,但会有一定的安全风险,建议选择按需新建的安全组。当前仅支持购买的时候指定一个安全组。
    EnhancedService EnhancedService object 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认开启云监控、云安全服务。
    ClientToken String 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

    3. 输出参数

    参数名称 类型 描述
    InstanceIdSet array of Strings 当通过本接口来创建实例时会返回该参数,表示一个或多个实例ID。返回实例ID列表并不代表实例创建成功,可根据 DescribeInstancesStatus 接口查询返回的 InstancesSet 中对应实例的ID的状态来判断创建是否完成;如果实例状态由“准备中”变为“正在运行”,则为创建成功。
    RequestId String 唯一请求ID。每次请求都会返回一个唯一的RequestId,当客户调用接口失败找后台研发人员处理时需提供该RequestId具体值。

    接口执行正常返回参数示例

    {
        "Response": {
            "InstanceIdSet": [
                "xxx1",
                "xxx2"
            ],
            "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
        }
    }