調用CreateInstance API建立預付費執行個體-邊緣節點服務 ENS-阿里雲

調用CreateInstance建立一台預付費執行個體。此介面可用RunInstances替代，後續CreateInstance不再迭代新功能。

介面說明

單使用者調用頻率：10 次/秒。
由於建立執行個體是非同步作業，建議您適當增加請求時間。當 API 返回 Code=0 時僅代表請求成功，並不代表成功建立執行個體，在請求成功時會返回執行個體 ID，然後您可以根據執行個體 ID 查詢執行個體是否建立成功。
InvalidUserData.NotInWhiteList 介面限制條件：只有配置了購買許可權的相關白名單才可以進行建立，否則報錯。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ens:CreateInstance

create

*Instance

acs:ens:*:{#accountId}:instance/*

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceType	string	是	執行個體規格。執行個體規格詳情請參見使用限制。	ens.se1.tiny
EnsRegionId	string	是	地區。	cn-hangzhou
Password	string	否	執行個體的密碼。長度為 8 至 30 個字元，必須同時包含大小寫英文字母、數字和特殊符號中的三類字元。可以設定以下特殊符號：()`~!@#$%^&*-_+=\|{}[]:;'<>,.?/	yourPassword:1
Period	string	是	購買資源的時間長度，取值範圍：1~9 和 12，單位：月。	12
ImageId	string	否	鏡像檔案 ID，啟動執行個體時選擇的鏡像資源。	yourImage ID
SystemDisk.Size	string	否	系統硬碟大小，單位為 GiB。取值：20，40，不能比鏡像小，需要為 10 的倍數。	40
Quantity	string	是	執行個體數量。	1
DataDisk.1.Size	string	否	第一塊資料盤的容量大小，單位為 GiB，容量至少為 20 GiB 且為 10 的倍數。	50
InternetChargeType	string	否	如果您第一次建立該參數為必傳。如果已有執行個體資源，則預設按照已存在的計費方式。取值： BandwidthByDay：日峰值頻寬。 95BandwidthByMonth：月 95 峰值頻寬。	95BandwidthByMonth
AutoRenewPeriod	string	否	每次自動續約的時間長度，當參數 AutoRenew 取值 True 時為必填。取值：1~12，單位：月。	12
AutoRenew	string	否	是否要自動續約。取值：True\|False（預設值）。	True
IpType	string	否	IP 類型。取值： ipv4（預設值）：IPv4。 ipv6：IPv6。 ipv4Andipv6：IPv4 和 IPv6。	ipv4
KeyPairName	string	否	金鑰組名稱。僅支援傳單個名稱。	TestKeyPairName
UserData	string	否	自訂資料，以`#!`開頭。目前，最長支援 256 字元，最大支援 16 KB。傳參內容僅支援自訂資料 Script，不支援 InstanceMetaData 渲染。您可傳入自訂資料。資料以 Base64 的方式編碼。調用 API 發起請求時，不會加密您設定的自訂資料，建議您不要以明文方式傳入機密的資訊，例如：密碼和私密金鑰等。如果需要傳入密碼和私密金鑰等內容，請您對內容進行加密後，然後以 Base64 的方式編碼後再傳入。在執行個體內部以同樣的方式反解密。詳情請參見資料格式。	#!/bin/sh echo "Hello World. The time is now $(date -R)!" \| tee /home/output.txt
VSwitchId	string	否	交換器 ID。	YourVSwitchId
PrivateIpAddress	string	否	內網地址。如果傳了內網地址，則 vSwitch 必傳。vSwitch 需要先建立好，否則會報錯。	10.10.10.10
PaymentType	string	否	支付方式。目前為固定值 Subscription：預付費執行個體，暫不支援修改。	Subscription
InstanceName	string	否	執行個體的名稱。命名規則如下所示：長度為 2~128 個英文或中文字元。必須以大小字母或中文開頭，不能以 http://和 https://開頭。可以包含數字、半形冒號（:）、底線（_）、英文句號（.）或者連字號（-）。如果沒有指定該參數，預設值為執行個體的 InstanceId。	test：Instance_Name.1-2
HostName	string	否	雲端服務器的主機名稱。通用命名規則：英文句號（.）和虛線（-）不能作為首尾字元，更不能連續使用。具體執行個體命名規則如下： Windows 執行個體：字元長度為 2~15，不支援英文句號（.），不能全是數字。允許大小寫英文字母、數字和虛線（-）。其他類型執行個體（Linux 等）：字元長度為 2~64，支援多個英文句號（.），英文句號之間為一段，每段允許大小寫英文字母、數字和虛線（-）。	test-HostName
UniqueSuffix	boolean	否	是否為 HostName 和 InstanceName 添加有序尾碼。有序尾碼從 001 開始遞增，最大不能超過 999。例如：LocalHost001，LocalHost002 和 MyInstance001，MyInstance002。預設值：false。	false
PublicIpIdentification	boolean	否	公網 IP 是否可以分配給指定執行個體。取值： true（預設值）：可以分配。 false：不可以分配。	true
PasswordInherit	boolean	否	是否使用鏡像預設的密碼。取值： true：使用鏡像預設的密碼，且 Password 參數必須為空白，同時您需要確保使用的鏡像已經設定了密碼。 false：不使用鏡像預設的密碼。	false

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	4A431388-2D4B-46F4-A96B-D4E6BD0688C1
InstanceIds	object
InstanceId	array	執行個體 ID 列表。
	string	執行個體 ID 列表。	[i-7ecpqvkicnchxccozrp**,i-6ecpqvkicnchxccozrp**]
Code	integer	返回碼，成功返回 0。說明如果您通過 SDK 方式調用該 API 會返回 Integer 類型，通用方式或者 HTTP 方式調用會返回字串類型。	0

樣本

正常返回樣本

JSON格式

{
  "RequestId": "4A431388-2D4B-46F4-A96B-D4E6BD0688C1",
  "InstanceIds": {
    "InstanceId": [
      "[i-7ecpqvkicnchxccozrp****,i-6ecpqvkicnchxccozrp****]"
    ]
  },
  "Code": 0
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	StockNotEnough	The specified instance type has insufficient resource.
400	InvalidUserData.NotInWhiteList	The specified user is not authroized to perform this operation.
400	MissingParameter	The input parameter that is mandatory for processing this request is not supplied.
400	InstanceIdNotFound	The input parameter instancdId that is not found.	指定的執行個體ID不存在。
400	NoPermission	Permission denied.
400	CallInterface	Call Interface Happen Error.	介面調用出錯。
400	InvalidParameter	The input parameter is Invalid.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.
400	InvalidDiskSize.ValueNotSupported	The specified disk capacity is invalid. Specify another capacity and try again.
400	InvalidParameter.Bandwidth	The specified parameter InternetChargeType is not valid.
400	InvalidParameter.Image	The specified image does not support.
400	InvalidParameter.InstanceType	The specified parameter InstanceType is not valid.
400	InvalidAccountStatus.NotEnoughBalance	Your account does not have enough balance.
400	unsupported_Ipv6Feature	This ensregion does not support creating instance of the IPv6 type. Select another type.
400	Forbidden.CreateInstance	The user is not in the Goods whitelist of creating instance interface.
400	ENS_OperationUnsupported_KeyPairName	The KeyPairNameis not available or image not support ssh key.
400	ENS_DependencyViolation_WindowsInstance	The instance creating is window, only user password to login.
400	ENS_PASSWORDORKEYPAIRNAME_MODULE_NOT_CHOOSEN	The required module pwd or keyPairName is not inputed
400	InvalidPrivateIpAddress	Specified private IP address is not in the CIDR block of virtual switch.
400	InvalidVSwitchId.NotFound	Specified virtual switch does not exist.	指定的虛擬交換器 ID 不存在。
400	InvalidPrivateIpAddress.Duplicated	Specified private IP address is duplicated.
400	InvalidPasswordParam.Mismatch	The input password should be null when passwordInherit is true.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。