批量創建并啟動實例。
接口說明
準備工作:
- 通過實名認證。更多詳情,請參見賬號實名認證相關文檔。
注意事項:
- 單次最多能創建 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 個字符,必須以大小字母或中文開頭,不能以 | instance |
Description | string | 否 | 實例的描述。長度為 2~256 個英文或中文字符,不能以 | 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 | 否 | 實例的付費方式。取值范圍:
| PostPaid |
PeriodUnit | string | 否 | 包年包月計費方式的時長單位。取值范圍:
| Month |
AutoRenew | boolean | 否 | 是否要自動續費。當參數 InstanceChargeType 取值 PrePaid 時才生效。取值范圍:
| true |
AutoPay | boolean | 否 | 是否自動支付,默認為 true | true |
Period | long | 否 | 周期時長,默認 1。
| 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 |
返回參數
示例
正常返回示例
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 入參發生變更 | 看變更集 | ||||||||
|