Elastic Compute Service：RunInstances

執行個體所屬的地域 ID。您可以呼叫 DescribeRegions 檢視最新的阿里雲地域清單。

映像 ID，啟動執行個體時選擇的映像資源。您可以透過 DescribeImages 查詢您可以使用的映像資源。如果您不指定LaunchTemplateId或LaunchTemplateName以確定啟動範本，也不透過指定ImageFamily選用映像族系最新可用映像，則ImageId為必選參數。

映像族系名稱，透過設定該參數來取得當前映像族系內最新可用映像來建立執行個體。

映像族系的名稱長度為 2~128 個字元。映像族系名稱不能以特殊字元、數字、http://、https://開頭，只可包含特殊字元中的"."、"_"、"-"和":"。

您需要注意：

• 設定了參數ImageId，則不能設定該參數。

• 未設定參數ImageId，但指定的LaunchTemplateId或LaunchTemplateName對應的啟動範本設定了ImageId，則不能設定該參數。

• 未設定ImageId，且指定的LaunchTemplateId或LaunchTemplateName對應的啟動範本未設定ImageId，則可以設定該參數。

• 未設定ImageId，且未設定LaunchTemplateId、LaunchTemplateName參數，則可以設定該參數。

執行個體的資源規格。如果您不指定LaunchTemplateId或LaunchTemplateName以確定啟動範本，InstanceType為必選參數。

• 產品選型：參見執行個體規格族或呼叫 DescribeInstanceTypes 檢視目標執行個體規格的效能資料，或者參見選型組態了解如何選擇執行個體規格。

• 查詢庫存：呼叫 DescribeAvailableResource 檢視指定地域或可用區內的資源供給情況。

新建立執行個體所屬於的安全性群組 ID。同一個安全性群組內的執行個體之間可以互相存取，一個安全性群組能容納的執行個體數量視安全性群組類型而定，具體請參見使用限制的安全性群組章節。

如果您不設定LaunchTemplateId或LaunchTemplateName以確定執行個體啟動範本，則安全性群組 ID 為必選參數。您需要注意：

• 您可以透過SecurityGroupId設定一個安全性群組，也可以透過SecurityGroupIds.N設定一個或多個安全性群組，但不支援同時設定SecurityGroupId和SecurityGroupIds.N。

• 如果NetworkInterface.N.InstanceType取值為Primary，則不能設定SecurityGroupId或SecurityGroupIds.N，只能設定NetworkInterface.N.SecurityGroupId或NetworkInterface.N.SecurityGroupIds.N。

虛擬交換器 ID。如果您建立的是 VPC 類型 ECS 執行個體，必須指定虛擬交換器 ID，且安全性群組和虛擬交換器在同一個專有網路 VPC 中。您可以呼叫 DescribeVSwitches 查詢已建立的交換器的相關資訊。

您需要注意：

• 如果您設定了VSwitchId參數，則設定的ZoneId參數必須和交換器所在的可用區保持一致。您也可以不設定ZoneId參數，系統將自動選擇指定交換器所在的可用區。

• 如果NetworkInterface.N.InstanceType取值為Primary，則不能設定VSwitchId，只能設定NetworkInterface.N.VSwitchId。

執行個體名稱。長度為 2~128 個字元，支援 Unicode 中 letter 分類下的字元（其中包括英文、中文等）和數字。可以包含半形冒號（:）、底線（_）、半形句號（.）或短劃線（-）。預設值為執行個體的InstanceId。

建立多台 ECS 執行個體時，您可以批次設定有序的執行個體名稱，並且可以包含方括號（[]）和逗號（,）。具體操作，請參見批次設定有序的執行個體名稱或主機名稱。

執行個體的描述。長度為 2~256 個英文或中文字元，不能以http://和https://開頭。

公網入頻寬最大值，單位為 Mbit/s。取值範圍：

• 當所購公網出頻寬小於等於 10 Mbit/s 時：1~10，預設為 10。

• 當所購公網出頻寬大於 10 Mbit/s 時：1~InternetMaxBandwidthOut的取值，預設為InternetMaxBandwidthOut的取值。

公網出頻寬最大值，單位為 Mbit/s。取值範圍：0~100。

預設值：0。

執行個體主機名稱。限制說明如下：

• 半形句號（.）和短劃線（-）不能作為首尾字元，更不能連續使用。

• Windows 執行個體：字元長度為 2~15，不支援半形句號（.），不能全是數字。允許包含大小寫英文字母、數字和短劃線（-）。

• 其他類型執行個體（Linux 等）：

  • 字元長度為 2~64，支援多個半形句號（.），點之間為一段，每段允許包含大小寫英文字母、數字和短劃線（-）。

  • 支援透過預留位置${instance_id}將執行個體 ID 寫入HostName參數。例如：HostName=k8s-${instance_id}，並且建立的 ECS 執行個體 ID 為i-123abc****，則該執行個體的主機名稱為k8s-i-123abc****。

建立多台 ECS 執行個體時，您可以：

• 批次設定有序的主機名稱。具體操作，請參見批次設定有序的執行個體名稱或主機名稱。

• 透過HostNames.N參數，為多台執行個體分別設定主機名稱。需要注意HostName參數和HostNames.N參數不能同時設定。

當建立多台執行個體時，是否為HostName和InstanceName自動新增有序後綴。有序後綴從 001 開始遞增，最大不能超過 999。取值範圍：

• true：新增。

• false：不新增。

預設值：false。

當HostName或InstanceName按照指定排序格式設定，未設定命名後綴name_suffix，即命名格式為name_prefix[begin_number,bits]時，UniqueSuffix不生效，名稱僅按照指定順序排序。

更多資訊，請參見批次設定有序的執行個體名稱或主機名稱。

執行個體的密碼。長度為 8 至 30 個字元，必須同時包含大小寫英文字母、數字和特殊符號中的三類字元。特殊符號可以是：

()`~!@#$%^&*-_+=|{}[]:;'<>,.?/

其中，Windows 執行個體不能以正斜線（/）為密碼首字元。

是否使用映像預設的密碼。取值範圍：

• true：使用。

• false：不使用。

預設值：false。

執行個體所屬的可用區 ID，您可以呼叫 DescribeZones 獲取可用區清單。

預設值：系統自動選擇。

網路計費類型。取值範圍：

• PayByBandwidth：按固定頻寬計費。

• PayByTraffic：按使用流量計費。

預設值：PayByTraffic。

系統磁碟大小，單位為 GiB。取值範圍：

• 普通雲端硬碟：20~500。

• ESSD 雲端硬碟：

  • PL0：1~2048。

  • PL1：20~2048。

  • PL2：461~2048。

  • PL3：1261~2048。

• ESSD AutoPL 雲端硬碟：1~2048。

• 其他雲端硬碟類型：20~2048。

該參數的取值必須大於或等於 max{1, ImageSize}。

預設值：max{40, 參數 ImageId 對應的映像大小}。

系統磁碟的雲端硬碟種類。取值範圍：

• cloud_efficiency：高效雲端硬碟。

• cloud_ssd：SSD 雲端硬碟。

• cloud_essd：ESSD 雲端硬碟。

• cloud：普通雲端硬碟。

• cloud_auto：ESSD AutoPL 雲端硬碟。

• cloud_essd_entry：ESSD Entry 雲端硬碟。

參數預設值說明：

• 當 InstanceType 為已停售且非 I/O 最佳化的執行個體規格，該參數預設值為cloud。

• 其它情況下，該參數預設值為cloud_efficiency。

系統磁碟名稱。長度為 2~128 個字元，支援 Unicode 中 letter 分類下的字元（其中包括英文、中文和數字等）。可以包含半形冒號（:）、底線（_）、半形句號（.）或短劃線（-）。

系統磁碟的描述。長度為 2~256 個英文或中文字元，不能以http://和https://開頭。

建立 ESSD 雲端硬碟作為系統磁碟使用時，設定雲端硬碟的效能等級。取值範圍：

• PL0：單碟最高隨機讀寫 IOPS 1 萬。

• PL1（預設）：單碟最高隨機讀寫 IOPS 5 萬。

• PL2：單碟最高隨機讀寫 IOPS 10 萬。

• PL3：單碟最高隨機讀寫 IOPS 100 萬。

有關如何選擇 ESSD 效能等級，請參見 ESSD 雲端硬碟。

系統磁碟採用的自動快照策略 ID。

是否為 I/O 最佳化執行個體。已停售的執行個體規格執行個體預設值是 none，其他執行個體規格預設值是 optimized。取值範圍：

• none：非 I/O 最佳化。

• optimized：I/O 最佳化。

執行個體自訂資料。必須填寫已採用 Base64 編碼後的資料，且在進行 Base64 編碼前自訂資料內容的大小不能超過 32 KB。

有關執行個體自訂資料的使用限制、格式以及執行頻率的詳細資訊，請參見執行個體自訂資料。

金鑰對名稱。

執行個體 RAM 角色名稱。您可以使用 RAM API ListRoles 查詢您已建立的執行個體 RAM 角色。

指定建立 ECS 執行個體的數量。取值範圍：1~100。

建立成功的 ECS 數量與指定的 Amount 和 minAmount 數量有關：

• 不指定 minAmount 時：按照 Amount 數量建立，庫存不滿足則 API 傳回建立失敗，同時一台也不會建立。

• 指定 minAmount 時：

  • 當 ECS 庫存數量＜minAmount：不會建立 ECS，同時 API 傳回建立失敗。

  • 當 minAmount≤ECS 庫存數量＜Amount，按照庫存數量建立執行個體，API 傳回建立成功。

  • 當 ECS 庫存數量≥Amount，按照指定的 Amount 建立，API 傳回建立成功。

預設值：1。

指定 ECS 執行個體最小購買數量。取值範圍：1~100。

建立成功的 ECS 數量與指定的 Amount 和 minAmount 數量有關：

• 不指定 minAmount 時：按照 Amount 數量建立，庫存不滿足則 API 傳回建立失敗，同時一台也不會建立。

• 指定 minAmount 時：

  • 當 ECS 庫存數量＜minAmount：不會建立 ECS，同時 API 傳回建立失敗。

  • 當 minAmount≤ECS 庫存數量＜Amount，按照庫存數量建立執行個體，API 傳回建立成功。

  • 當 ECS 庫存數量≥Amount，按照指定的 Amount 建立，API 傳回建立成功。

按量付費執行個體的自動釋放時間。按照ISO 8601標準表示，使用 UTC+0 時間。格式為：yyyy-MM-ddTHH:mm:ssZ。

• 如果秒（ss）取值不是00，則自動取為當前分鐘（mm）開始時。

• 最短釋放時間為當前時間半小時之後。

• 最長釋放時間不能超過當前時間三年。

按量付費執行個體的競價策略。當參數InstanceChargeType取值為PostPaid時生效。取值範圍：

• NoSpot：正常按量付費執行個體。

• SpotWithPriceLimit：設定上限價格的搶佔式執行個體。

• SpotAsPriceGo：系統自動出價，跟隨當前市場實際價格。

預設值：NoSpot。

搶佔式執行個體的保留時長，單位為小時。 取值：

• 1：建立後阿里雲會保證執行個體執行 1 小時不會被自動釋放；超過 1 小時後，系統會即時比較出價與市場價格、檢查資源庫存，來決定執行個體的持有和回收。

• 0：建立後，阿里雲不保證執行個體執行時長，系統會即時比較出價與市場價格、檢查資源庫存，來決定執行個體的持有和回收。

預設值：1。

設定執行個體的每小時最高價格。支援最大 3 位小數，參數SpotStrategy取值為SpotWithPriceLimit時生效。

搶佔執行個體中斷模式。取值範圍：

• Terminate：直接釋放執行個體。

• Stop：執行個體進入節省停機模式。

  關於節省停機模式的更多說明，請參見按量付費執行個體節省停機模式。

預設值：Terminate。

是否開啟安全性加固。取值範圍：

• Active：啟用安全性加固，只對公用映像生效。

• Deactive：不啟用安全性加固，對所有映像類型生效。

保證請求冪等性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元，且不能超過 64 個字元。更多資訊，請參見如何保證冪等性。

執行個體所屬的 HPC 叢集 ID。

建立 SCC 執行個體時，該參數為必選參數。您可以參考 CreateHpcCluster 建立 HPC 叢集。

是否只預檢此次請求。取值範圍：

• true：傳送檢查請求，不會建立執行個體。檢查項目包括是否填寫了必需參數、請求格式、業務限制和 ECS 庫存。如果檢查不通過，則傳回對應錯誤。如果檢查通過，則傳回錯誤碼DryRunOperation。

• false（預設）：傳送正常請求，通過檢查後直接建立執行個體。

專屬宿主機 ID。

您可以透過 DescribeDedicatedHosts 查詢專屬宿主機 ID 清單。

啟動範本 ID。更多資訊，請呼叫 DescribeLaunchTemplates 。

使用啟動範本建立執行個體時，您必須指定LaunchTemplateId或LaunchTemplateName確定啟動範本。

啟動範本名稱。

使用啟動範本建立執行個體時，您必須指定LaunchTemplateId或LaunchTemplateName確定啟動範本。

啟動範本版本。如果您指定了LaunchTemplateId或LaunchTemplateName而不指定啟動範本版本號，則採用預設版本。

執行個體所在的企業資源群組 ID。

購買資源的時長，單位由PeriodUnit指定。當參數InstanceChargeType取值為PrePaid時才生效且為必選值。一旦指定了DedicatedHostId，則取值範圍不能超過專屬宿主機的訂閱時長。取值範圍：

PeriodUnit=Month 時，Period 取值：1、2、3、4、5、6、7、8、9、12、24、36、48、60。

包年包月計費方式的時長單位。取值範圍：

Month（預設）。

是否要自動續約。當參數InstanceChargeType取值PrePaid時才生效。取值範圍：

• true：自動續約。

• false：不自動續約。

預設值：false。

單次自動續約的續約時長。取值範圍：

PeriodUnit=Month 時：1、2、3、6、12、24、36、48、60。

預設值：1。

執行個體的付費方式。取值範圍：

• PrePaid：包年包月。

• PostPaid：按量付費。

預設值：PostPaid。

選擇包年包月時，您必須確認自己的帳號支援信用支付，否則將傳回InvalidPayMethod的錯誤提示。

部署集 ID。

如果您設定的部署集對應的策略為部署集組高可用性策略（AvailabilityGroup），可以透過該參數指定執行個體在部署集中的分組號。取值範圍：1~7。

執行個體私網 IP 位址。專有網路 VPC 類型 ECS 執行個體設定私網 IP 位址時，必須從虛擬交換器（VSwitchId）的空閒網段中選擇。

您需要注意：

• 設定PrivateIpAddress後：

  • 如果Amount參數取值為 1，則表示為建立的一台 ECS 執行個體分配私網 IP 位址。

  • 如果Amount參數取值大於 1，則表示在批次建立 ECS 執行個體時，以指定的私網 IP 位址為起始位址，依次為多台 ECS 執行個體分配連續的私網 IP 位址，但需要注意，此時不支援再為執行個體綁定輔助網卡（即不支援再設定NetworkInterface.N.*這類參數）。

• 如果NetworkInterface.N.InstanceType取值為Primary，則不能設定PrivateIpAddress，只能設定NetworkInterface.N.PrimaryIpAddress。

設定突發效能執行個體的執行模式。取值範圍：

• Standard：標準模式，執行個體效能請參見什麼是突發效能執行個體下的效能約束模式章節。

• Unlimited：無效能約束模式，執行個體效能請參見什麼是突發效能執行個體下的無效能約束模式章節。

為主網卡指定隨機產生的 IPv6 位址數量。取值範圍：1~10。

您需要注意：

• 您不能同時設定Ipv6Address.N和Ipv6AddressCount。

• 如果NetworkInterface.N.InstanceType取值為Primary，則不能設定Ipv6Address.N或Ipv6AddressCount，只能設定NetworkInterface.N.Ipv6Address.N或NetworkInterface.N.Ipv6AddressCount。

主要網路介面佇列數。您需要注意：

• 不能超過執行個體規格允許的單個網路介面最大佇列數。

• 執行個體的所有網路介面累加佇列數不能超過執行個體規格允許的佇列數總配額。執行個體規格的單個網路介面最大佇列數和總配額可以透過 DescribeInstanceTypes 介面查詢MaximumQueueNumberPerEni、TotalEniQueueQuantity欄位。

• 如果NetworkInterface.N.InstanceType取值為Primary，則不能設定NetworkInterfaceQueueNumber，只能設定NetworkInterface.N.QueueNumber。

執行個體釋放保護屬性，指定是否支援透過控制台或 API（ DeleteInstance ）釋放執行個體。取值範圍：

• true：開啟執行個體釋放保護。

• false：關閉執行個體釋放保護。

預設值：false。

專屬宿主機執行個體是否與專屬宿主機關聯。取值範圍：

• default：執行個體不與專屬宿主機關聯。已啟用節省停機模式的執行個體，停機後再次啟動時，若原專屬宿主機可用資源不足，則執行個體被放置在自動部署資源池的其他專屬宿主機上。

• host：執行個體與專屬宿主機關聯。已啟用節省停機模式的執行個體，停機後再次啟動時，仍放置在原專屬宿主機上。若原專屬宿主機可用資源不足，則執行個體重新啟動失敗。

預設值：default。

是否在專屬宿主機上建立執行個體。取值範圍：

• default：建立非專屬宿主機執行個體。

• host：建立專屬宿主機執行個體。若您不指定DedicatedHostId，則由阿里雲自動選擇專屬宿主機放置執行個體。

預設值：default。

儲存集 ID。

儲存集中的最大分區數量。取值範圍：大於等於 1。

CPU 核心數。

CPU 執行緒數。ECS 執行個體的 vCPU 數=CpuOptions.Core取值*CpuOptions.ThreadsPerCore取值。

• CpuOptions.ThreadsPerCore=1表示關閉 CPU 超執行緒。

• 僅部分執行個體規格支援設定 CPU 執行緒數。

該參數已棄用。

執行個體的 Cpu 拓撲類型。取值範圍：

• ContinuousCoreToHTMapping：當選擇ContinuousCoreToHTMapping時，執行個體的 Cpu 拓撲中，執行個體的同一個 Core 的 HT 是連續的。

• DiscreteCoreToHTMapping：當選擇DiscreteCoreToHTMapping時，執行個體的同一個 Core 的 HT 是離散的。

預設值：無。

可信系統模式。取值：vTPM。

目前，可信系統模式支援的執行個體規格族：

• g7、c7、r7。

• 安全增強型（g7t、c7t、r7t）。

當您建立以上執行個體規格族的 ECS 執行個體時，需要設定該參數。具體說明如下：

• 如果您使用阿里雲可信系統，請將該參數值設定為 vTPM，在執行個體啟動時即可透過阿里雲可信系統完成可信校驗。

• 如果您不使用阿里雲可信系統，可以不設定該參數值，但您需要注意，如果您所建立的 ECS 執行個體使用了 Enclave 機密運算模式（SecurityOptions.ConfidentialComputingMode=Enclave），則該 ECS 執行個體也會啟用可信系統。

• 透過 OpenAPI 建立可信系統的 ECS 執行個體時，只能呼叫RunInstances實現，CreateInstance目前不支援設定SecurityOptions.TrustedSystemMode參數。

關於可信系統的更多資訊，請參見安全增強型執行個體可信功能概述。

機密運算模式。取值：Enclave。

該參數取值為 Enclave 時，表示 ECS 執行個體使用 Enclave 建構機密運算環境。目前僅執行個體規格族 c7、g7、r7，支援呼叫RunInstances時指定該參數使用 Enclave 機密運算。您需要注意：

• 機密運算功能正在邀測中。

• 透過 OpenAPI 建立 Enclave 機密運算的 ECS 執行個體時，只能呼叫RunInstances實現，CreateInstance目前不支援設定SecurityOptions.ConfidentialComputingMode參數。

• Enclave 機密運算依託可信系統（vTPM）實現，當您指定 ECS 執行個體使用 Enclave 建構機密運算環境時，該執行個體同時也會啟用可信系統。因此，呼叫該介面時，如果設定了SecurityOptions.ConfidentialComputingMode=Enclave，則無論您是否設定了SecurityOptions.TrustedSystemMode=vTPM，最終建立的 ECS 執行個體均會啟用 Enclave 機密運算模式以及可信系統。

關於機密運算的更多資訊，請參見使用 Enclave 建構機密運算環境。

是否啟用執行個體中繼資料的存取通道。取值範圍：

• enabled：啟用。

• disabled：停用。

預設值：enabled。

存取執行個體中繼資料時是否強制使用加固模式（IMDSv2）。取值範圍：

• optional：不強制使用。

• required：強制使用。設定該取值後，普通模式無法存取執行個體中繼資料。

預設值：optional。

執行個體啟動的私有池容量選項。彈性保障服務或容量預定服務在生效後會產生私有池容量，供執行個體啟動時選擇。取值範圍：

• Open：開放模式。將自動匹配開放類型的私有池容量。如果沒有符合條件的私有池容量，則使用公用池資源啟動。該模式下無需設定PrivatePoolOptions.Id參數。

• Target：指定模式。使用指定的私有池容量啟動執行個體，如果該私有池容量不可用，則執行個體會啟動失敗。該模式下必須指定私有池 ID，即PrivatePoolOptions.Id參數為必填項。

• None：不使用模式。執行個體啟動將不使用私有池容量。

預設值：None。

以下任一場景，執行個體啟動的私有池容量選項只能取值None或不傳值。

• 建立搶佔式執行個體。

• 在專屬宿主機 DDH 上建立 ECS 執行個體。

私有池 ID。即彈性保障服務 ID 或容量預定服務 ID。

指定 ECS 執行個體所屬的專屬宿主機叢集，系統會自動選擇該專屬宿主機叢集中的一台專屬宿主機部署 ECS 執行個體。

在您同時指定了專屬宿主機（DedicatedHostId）和專屬宿主機叢集（SchedulerOptions.DedicatedHostClusterId）時：

• 如果專屬宿主機屬於專屬宿主機叢集，則優先將 ECS 執行個體部署在指定的專屬宿主機上。

• 如果專屬宿主機不屬於專屬宿主機叢集，則 ECS 執行個體建立失敗。

您可以透過 DescribeDedicatedHostClusters 查詢專屬宿主機叢集 ID 清單。

建立執行個體時，是否自動支付。取值範圍：

• true：自動支付。

  說明

  自動支付時，請確保支付方式餘額充足，否則會產生異常訂單，只能作廢訂單。如果您的支付方式餘額不足，可以將參數AutoPay設為false，此時會產生未支付訂單，您可以登入 ECS 管理主控台自行支付。

• false：只產生訂單不扣費。

  說明

  當InstanceChargeType 取值為PostPaid時，AutoPay不能設定為false。

預設值：true。

平台託管主機的唯一識別碼，如 mh-f2d3647ca21****。