调用RunInstances批量创建并启动实例-阿里云帮助中心

批量创建并启动实例。

接口说明

准备工作：

通过实名认证。更多详情，请参见账号实名认证相关文档。

注意事项：

单次最多能创建 100 台实例。
接口功能为创建并启动实例。
当遇到由于库存不足等不可抗因素导致的实例生产失败，实例会被自动回滚释放。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
cloudphone:RunInstances	Write	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域	cn-hangzhou
InstanceName	string	否	实例名称。长度为 2~128 个字符，必须以大小字母或中文开头，不能以`http://`或`https://`开头。可以包含中文、英文、数字、半角冒号（:）、下划线（_）、半角句号（.）或者短划线（-）。默认值为实例的 InstanceId。	instance
Description	string	否	实例的描述。长度为 2~256 个英文或中文字符，不能以`http://`或`https://`开头。	cloudphone instance
InstanceType	string	是	实例规格	ecp.ce.large
ImageId	string	是	镜像 ID	cpm-xxxx
SecurityGroupId	string	是	安全组 ID，与 ECS 使用相同的安全组。	sg-xxxxx
VSwitchId	string	是	虚拟交换机 ID	vsw-xxxx
EipBandwidth	integer	否	EIP 带宽值，取值范围 1-200。设置此参数，将自动创建对应带宽的 EIP 实例，并将 EIP 实例绑定到云手机实例。实例释放时，此 EIP 实例会一起释放回收。	2
Resolution	string	否	云手机实例选用的分辨率，可通过 DescribeInstanceTypes 接口查询当前规格支持的分辨率列表，选择合适的分辨率。	1920*1080
Amount	integer	否	指定创建 ECS 实例的数量。取值范围：1~100 默认值：1	10
KeyPairName	string	否	云手机实例密钥对名称。可通过 ImportKeyPair 接口导入云手机密钥。	keypair
ClientToken	string	否	保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。更多详情，请参见如何保证幂等性。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
ChargeType	string	否	实例的付费方式。取值范围： PrePaid：包年包月 PostPaid（默认）：按量付费	PostPaid
PeriodUnit	string	否	包年包月计费方式的时长单位。取值范围： Year Month（默认）	Month
AutoRenew	boolean	否	是否要自动续费。当参数 InstanceChargeType 取值 PrePaid 时才生效。取值范围： true：自动续费 false（默认）：不自动续费	true
AutoPay	boolean	否	是否自动支付，默认为 true	true
Period	long	否	周期时长，默认 1。 PeriodUnit 为 Month 时，支持 1、2、3、6 PeriodUnit 为 Year 时，支持 1、2、3、4、5	1
Tag	object []	否	实例的标签集合。
Key	string	否	实例的标签键。N 的取值范围为 1~20。	TestKey
Value	string	否	实例的标签值。N 的取值范围为 1~20。	TestValue
PrivateIpAddress	string	否	云手机私网 IP 地址。云手机实例设置私网 IP 地址时，必须从虚拟交换机（VSwitchId）的空闲网段中选择。您需要注意：设置 PrivateIpAddress 后，Amount 参数取值必须为 1，表示为创建一台指定私网 IP 的云手机。	192.168.157.224

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
OrderId	string	订单号	9611111323245
TradePrice	float	价格	133.32
InstanceIds	array	实例 ID 列表
	string	实例 ID 列表	cp-xxxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "OrderId": "9611111323245",
  "TradePrice": 133.32,
  "InstanceIds": {
    "InstanceId": [
      "cp-xxxxx"
    ]
  }
}

错误码

HTTP status code	错误码	错误信息
403	QuotaExceed	Instance quota exceed.

访问错误中心查看更多错误码。

变更历史

变更时间

变更内容概要

操作

2022-06-10

OpenAPI 错误码发生变更、OpenAPI 入参发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：403
入参	OpenAPI 入参发生变更。
	新增入参：PrivateIpAddress