调用RunInstances批量创建并启动实例

接口说明

准备工作:

注意事项:

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String RunInstances

接口名称

ImageId String cpm-xxxx

镜像ID

InstanceType String ecp.ce.large

实例规格

RegionId String cn-hangzhou

地域

SecurityGroupId String sg-xxxxx

安全组ID,与ECS使用相同的安全组。

VSwitchId String vsw-xxxx

虚拟交换机ID

InstanceName String instance

实例名称。长度为2~128个字符,必须以大小字母或中文开头,不能以http://和https://开头。可以包含中文、英文、数字、半角冒号(:)、下划线(_)、半角句号(.)或者短划线(-)。默认值为实例的InstanceId。

Description String cloudphone instance

实例的描述。长度为2~256个英文或中文字符,不能以http://和https://开头。

EipBandwidth Integer 2

EIP带宽值,取值范围1-200。设置此参数,将自动创建对应带宽的EIP实例,并将EIP实例绑定到云手机实例。实例释放时,此EIP实例会一起释放回收。

Resolution String 1920*1080

云手机实例选用的分辨率,可通过DescribeInstanceTypes接口查询当前规格支持的分辨率列表,选择合适的分辨率。

Amount Integer 10

指定创建ECS实例的数量。取值范围:1~100

默认值:1

KeyPairName String keypair

云手机实例密钥对名称。可通过ImportKeyPair接口导入云手机秘钥。

ClientToken String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。更多详情,请参见如何保证幂等性。

返回数据

名称 类型 示例值 描述
InstanceIds List cp-xxxxx

实例ID列表

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID

示例

请求示例

http(s)://[Endpoint]/?Action=RunInstances
&<公共请求参数>

正常返回示例

XML格式

<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
<InstanceIds>
    <InstanceId>cp-xxxxx</InstanceId>
</InstanceIds>

JSON格式

{"RequestId":"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E","InstanceIds":{"InstanceId":"cp-xxxxx"}}

错误码

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