首页 弹性云手机 API参考指南 API目录 实例 RunInstances - 批量创建并启动实例

RunInstances - 批量创建并启动实例

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

接口说明

准备工作:

注意事项:

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用加粗字体表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cloudphone:RunInstancesWrite
  • ECP
    acs:cloudphone:{#regionId}:{#accountId}:image/{#imageId}
  • ECP
    acs:cloudphone:{#regionId}:{#accountId}:instance/*
  • ECP
    acs:cloudphone:{#regionId}:{#accountId}:keypair/*
  • ECP
    acs:cloudphone:{#regionId}:{#accountId}:keypair/{#KeyPairName}
  • ECS
    acs:ecs:{#regionId}:{#accountId}:securitygroup/{#SecurityGroupId}
  • VPC
    acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}

请求参数

名称类型必填描述示例值
RegionIdstring

地域

cn-hangzhou
InstanceNamestringinstance
Descriptionstring

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

cloudphone instance
InstanceTypestring

实例规格

ecp.ce.large
ImageIdstring

镜像ID

cpm-xxxx
SecurityGroupIdstring

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

sg-xxxxx
VSwitchIdstring

虚拟交换机ID

vsw-xxxx
EipBandwidthinteger

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

2
Resolutionstring

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

1920*1080
Amountinteger

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

默认值:1

10
KeyPairNamestring

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

keypair
ClientTokenstring

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

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
ChargeTypestring

实例的付费方式。取值范围:

  • PrePaid:包年包月
  • PostPaid(默认):按量付费
PostPaid
PeriodUnitstring

包年包月计费方式的时长单位。取值范围:

  • Year
  • Month(默认)
Month
AutoRenewboolean

是否要自动续费。当参数InstanceChargeType取值PrePaid时才生效。取值范围:

  • true:自动续费
  • false(默认):不自动续费
true
AutoPayboolean

是否自动支付,默认为true

true
PeriodLong

周期时长,默认1。

  • PeriodUnit为Month时,支持1、2、3、6
  • PeriodUnit为Year时,支持1、2、3、4、5
1
Tagarray

实例的标签集合。

object
Keystring

实例的标签键。N的取值范围为1~20。

TestKey
Valuestring

实例的标签值。N的取值范围为1~20。

TestValue
PrivateIpAddressstring

云手机私网IP地址。云手机实例设置私网IP地址时,必须从虚拟交换机(VSwitchId)的空闲网段中选择。 您需要注意: 设置PrivateIpAddress后,Amount参数取值必须为1,表示为创建一台指定私网IP的云手机。

192.168.157.224

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
OrderIdstring

订单号

9611111323245
TradePricenumber

价格

133.32
InstanceIdsarray

实例ID列表

string

实例ID列表

cp-xxxxx

示例

请求示例

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

正常返回示例

JSON格式

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

错误码

Http code错误码错误信息
403QuotaExceedInstance quota exceed.

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

变更历史

变更时间变更内容概要操作
2022-06-10OpenAPI 错误码发生变更、 OpenAPI 入参发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
入参OpenAPI 入参发生变更
    新增入参:PrivateIpAddress
2021-11-26 OpenAPI RunInstances 已下线
变更项变更内容
阿里云首页 弹性云手机 相关技术圈