此介面用於修改一台包年包月 ECS 執行個體的執行個體規格,支援您升級或降低執行個體規格,修改後的執行個體規格在執行個體整個生命週期內生效。
介面說明
請確保在使用該介面前,已充分了解 ECS 產品的收費方式、價格以及降配退款規則。
此介面屬於非同步操作,等待約 5~10 秒後配置變更完成。升級或降低包年包月 ECS 執行個體規格前,您可以透過 DescribeResourcesModification 查詢目前執行個體支援變更配置的執行個體規格。
注意事項
-
若原執行個體規格與目標執行個體規格的 NVMe 屬性不一致( DescribelnstanceTypes 的
NvmeSupport欄位),且作業系統為 win( Describelnstances 的OStype欄位),則需要您參考預防措施完成操作後再進行變更配置。 -
已過期執行個體無法修改執行個體規格,您可以續費後重新操作。
-
降低執行個體規格:
執行個體必須處於已停止(
Stopped)狀態。降低前後的執行個體規格價差退款會退還到您的原付費方式中,已使用的代金券不退回。
變更配置後的執行個體規格需要啟動執行個體後生效。
-
升級執行個體規格:
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ecs:ModifyPrepayInstanceSpec |
update |
*Instance
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| InstanceId |
string |
是 |
執行個體 ID。 |
i-bp67acfmxazb4ph**** |
| RegionId |
string |
是 |
執行個體所屬的地域 ID。您可以呼叫 DescribeRegions 查看最新的阿里雲端地域列表。 |
cn-hangzhou |
| InstanceType |
string |
是 |
需要變更配置的目標執行個體規格。取值請參見執行個體規格族或呼叫 DescribeInstanceTypes 。 |
ecs.g5.xlarge |
| OperatorType |
string |
否 |
操作類型。取值範圍: 說明
該參數可無需上傳,系統可自動判斷升配還是降配;若要上傳,請按照下面的邏輯規則操作。
說明
升級或降低執行個體規格的注意事項請參見上文介面說明章節。 |
upgrade |
| ClientToken |
string |
否 |
保證請求冪等性。從您的用戶端產生一個參數值,確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元,且不能超過 64 個字元。更多資訊,請參見如何保證冪等性。 |
123e4567-e89b-12d3-a456-426655440000 |
| AutoPay |
boolean |
否 |
升級執行個體規格時,是否自動支付。取值範圍:
預設值:true。 說明
|
true |
| MigrateAcrossZone |
boolean |
否 |
是否支援跨叢集升級執行個體規格。取值範圍:
預設值:false。 當參數 專有網路 VPC 類型執行個體:對於已停售的執行個體規格,非 I/O 最佳化執行個體變更配置到 I/O 最佳化執行個體時,雲端伺服器磁碟裝置名稱和軟體授權碼會發生變化。Linux 執行個體的普通雲端硬碟(cloud)會被識別為 xvda 或 xvdb 等,高效能雲端硬碟(cloud_efficiency)和 SSD 雲端硬碟(cloud_ssd)會被識別為 vda 或 vdb 等。 |
false |
| SystemDisk.Category |
string |
否 |
更換系統磁碟類型。取值範圍:
說明
該參數僅支援從已停售的執行個體規格升級到正常販售的執行個體規格族,並將非 I/O 最佳化執行個體規格升級為 I/O 最佳化執行個體規格時有效。 |
cloud_efficiency |
| RebootTime |
string |
否 |
執行個體的重新啟動時間。按照 ISO 8601 標準表示,使用 UTC+0 時間。格式為:yyyy-MM-ddTHH:mmZ。 |
2018-01-01T12:05Z |
| EndTime |
string |
否 |
臨時變更的終止時間。按照 ISO 8601 標準表示,使用 UTC+0 時間。格式為:yyyy-MM-ddTHH:mmZ。 |
2018-01-01T12:05Z |
| RebootWhenFinished |
boolean |
否 |
執行個體變更配置結束後是否立即重新啟動。取值範圍:
預設值為 false。 說明
若執行個體處於已停止狀態,即使您設定了 |
false |
| ModifyMode |
string |
否 |
說明
該參數暫未開放使用。 |
null |
| Disk |
array<object> |
否 |
說明
該參數暫未開放使用。 |
|
|
object |
否 |
說明
該參數暫未開放使用。 |
||
| DiskId |
string |
否 |
說明
該參數暫未開放使用。 |
null |
| Category |
string |
否 |
說明
該參數暫未開放使用。 |
null |
| PerformanceLevel |
string |
否 |
說明
該參數暫未開放使用。 |
null |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| OrderId |
string |
產生的訂單 ID。 |
1234567890 |
| RequestId |
string |
請求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
樣本
正常返回樣本
JSON格式
{
"OrderId": "1234567890",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidInstanceType.ValueUnauthorized | The specified InstanceType is not authorized. | |
| 400 | InvalidInstanceType.ValueNotSupported | The specified InstanceType does not exist or beyond the permitted range. | 指定的執行個體規格不支援目前執行個體掛載的資料磁碟規格。 |
| 400 | InvalidBillingMethod.ValueNotSupported | The operation is not permitted due to an invalid billing method of the instance. | 由於執行個體的計費方式無效,該操作不允許。 |
| 400 | InvalidInstance.PurchaseNotFound | The specified instance has no purchase history. | 該執行個體的訂購記錄不存在。 |
| 400 | InvalidInstance.UnpaidOrder | The specified instance has unpaid order. | |
| 400 | InvalidInstanceType.NotSupported | The specified InstanceType is not Supported. | |
| 400 | OrderCreationFailed | Order creation failed, please check your params and try it again later. | 建立訂單失敗,請檢查您的參數,然後再試。 |
| 400 | Throttling | You have made too many requests within a short time; your request is denied due to request throttling. | 請求限流,請使用 nextToken 的分頁方式替代 PageNumber 的分頁方式進行查詢。 |
| 400 | Account.Arrearage | Your account has an outstanding payment. | 您的帳號存在未支付的款項。 |
| 400 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | |
| 400 | InvalidRebootTime.MalFormed | The specified rebootTime is not valid. | 指定的 RebootTime 不合法。 |
| 400 | InvalidRebootTime.ValueNotSupported | The specified RebootTime is not valid. | 指定的重新啟動時間超出取值範圍。 |
| 400 | IdempotenceParamNotMatch | Request uses a client token in a previous request but is not identical to that request. | 冪等參數不相符。 |
| 400 | InvalidInstanceChargeType.ValueNotSupported | %s | 指定執行個體的付費類型不支援。 |
| 400 | InvalidStatus.NotStopped | Instance status must be stopped. | 執行個體只有在已停止的狀態下,才能進行此操作。 |
| 400 | InvalidAction | %s | 指定的操作類型不支援。 |
| 400 | InstanceDowngrade.QuotaExceed | Quota of instance downgrade is exceed. | 您的執行個體降級已超額度,無法進行此操作。 |
| 400 | InvalidParameter | %s | 指定的參數組合不符合要求。 |
| 400 | OperationDenied | The current user does not support this operation. | 指定的 EIP 不可用或未獲授權。 |
| 400 | LastOrderProcessing | The previous order is still processing, please try again later. | 訂單正在處理中,稍後重試。 |
| 400 | InvalidOperation.VpcHasEnabledAdvancedNetworkFeature | The specified vpc has enabled advanced network feature. | 該 VPC 開啟了進階特性,不能建立低規格的 ECS。 |
| 400 | InvalidAction.WithActiveElasticUpgrade | The instance has active Elastic Upgrade. | |
| 400 | InstanceTypeNotSupported.TooManyDisksAttached | %s | |
| 400 | QuotaExceed.DiskCapacity | The used capacity of disk type has exceeded the quota in the zone, %s. | 指定磁碟類型的已用容量超出可用區配額限制,您可以前往配額中心查詢和申請提升磁碟容量配額。 |
| 400 | MissingParameter.DiskCategory | The specified parameter Disk.Category can not be null when Disk.DiskId is specified. | |
| 400 | InvalidParameter.DiskCategory | The specified parameter Disk.Category is not valid. | |
| 400 | InvalidPerformanceLevel.Malformed | The specified parameter Disk.n.PerformanceLevel is not valid. | |
| 400 | InvalidSystemDiskCategory.NotMatchInstanceType | The system disk category does not match the instance type. | 系統磁碟類別與執行個體規格不符。 |
| 400 | QuotaExceed.RufundVcpu | The maximum number of refunded vcpu is exceeded: %s . | 退款規則中 vCPU 配額超過了最大數量限制,具體限制請參見錯誤訊息中 %s 佔位符的實際資訊。 |
| 400 | NoPermission.Price | The operation requires price permission. Please either apply for permission from your main account, or set the parameter AutoPay as true. | 該操作需要價格權限。請向您的主帳戶申請權限,或將參數 AutoPay 設定為 true 進行自動支付。 |
| 400 | NoPermission.Refund | The operation requires refund permission. Please apply for permission from your main account. | 該帳號無權限操作退款,主帳號需要授權退款相關權限。 |
| 400 | InvalidInstanceStatus | The current status of the instance does not support this operation. | |
| 400 | InvalidOperation.InstanceRenewWithDowngradeInPlan | The operation is denied due to the specified instance has renew with downgrade record in plan. | 存在未生效的續費降配訂單。訂單生效前不允許此操作。 |
| 400 | InvalidOperation.OnlineModificationUnsupported | Online modification of instance type is not supported for the specified instance due to its CPU topology. | 目前 CPU 拓撲類型不支援熱變更配置。 |
| 400 | InvalidInstanceType.NotSupportCpuOptionsNestedVirtualization | The specified instance type does not support CpuOptions.NestedVirtualization: %s. | 目前規格不支援指定的巢狀虛擬化能力。 |
| 401 | InvalidInstanceType.ValueUnauthorized | The specified InstanceType is not authorized. | 您指定的執行個體規格不存在,或者您沒有權限操作此規格的執行個體。 |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 傳送請求時發生錯誤,請稍後重試。 |
| 500 | ImageOrderFailed | Create marketplace image order failed. | 建立雲端市場訂單失敗,請提交工單處理。 |
| 403 | OperationDenied.NoStock | The specified instance is out of usage. | 目前規格沒有庫存。 |
| 403 | InvalidInstanceType.ValueNotSupported | The specified InstanceType does not exist or beyond the permitted range. | |
| 403 | InvalidUser.PassRoleForbidden | The RAM user does not have privilege to pass a role. | RAM 子帳號不具備授予 ECS RAM 角色的權限。 |
| 403 | ImageNotSupportInstanceType | The specified image does not support the specified InstanceType. | 指定的映像不支援選定執行個體規格的執行個體。 |
| 403 | InstanceType.Offline | %s | 指定的執行個體規格已下線。 |
| 403 | IncorrectInstanceStatus | The current status of the resource does not support this operation. | |
| 403 | Throttling | You have made too many requests within a short time; your request is denied due to request throttling. | |
| 403 | InvalidParameter.InstanceId | %s | 找不到指定的執行個體。 |
| 403 | OperationDenied | %s | |
| 403 | InvalidInstanceStatus | The current status of the instance does not support this operation. | 目前執行個體的狀態不支援此操作。 |
| 403 | InvalidOperation.StarterPackage | StarterPackage not support modification. | |
| 403 | InvalidInstance.PreInstanceExpired | Instance business status is not Expired. | |
| 403 | InvalidInstance.EipNotSupport | The special instance with eip not support operate, please unassociate eip first. | 已綁定 EIP 的執行個體不支援該操作,請優先解除綁定 EIP。 |
| 403 | OperationDenied.ImageNotValid | The specified image is not authorized. | |
| 403 | OperationDenied.LocalDiskUnsupported | The configuration change is not allowed when the specified instance has local disks mounted. | 執行個體掛載本機磁碟後不支援規格變更。 |
| 403 | InvalidOperation.EniCountExceeded | %s | |
| 403 | InvalidOperation.Ipv4CountExceeded | %s | 當前 ECS 綁定的彈性網卡上的 IPv4 位址數量超過了目標規格的限制。 |
| 403 | InvalidOperation.Ipv6CountExceeded | %s | 當前 ECS 執行個體綁定的彈性網卡上的 IPv6 位址數量超過了目標規格的限制。 |
| 403 | InvalidOperation.Ipv6NotSupport | %s | 當前執行個體規格不支援 IPv6。 |
| 403 | InvalidOperation.Ipv4NotSupport | %s | |
| 403 | InvalidInstance.NotFoundSystemDisk | The specified instance has no system disk. | |
| 403 | InvalidInstanceType.NotSupportDiskCategory | The instanceType of the specified instance does not support this disk category. | 指定的執行個體規格(InstanceType)不支援目前執行個體的雲端硬碟類別。請嘗試更換其他執行個體規格。關於執行個體規格支援的雲端硬碟類型,請參閱執行個體規格族文件。 |
| 403 | QuotaExceed.ElasticQuota | No additional quota is available for the specified ECS instance type. | ECS 用量超過配額上限,請到阿里雲官網控制台申請提升配額。 |
| 403 | InvalidResourceType.NotSupported | %s | 指定資源組合不存在,請更換其他可用區或規格。 |
| 403 | InvalidOperation.MaxEniQueueNumberExceeded | %s | 彈性網卡佇列數超過上限,具體資訊請參見錯誤訊息 %s 預留位置的實際返回結果。 |
| 403 | InvalidOperation.ExceedInstanceTypeQueueNumber | %s | 目前 ECS 執行個體綁定的彈性網卡佇列數超過了目標規格限制的網卡佇列數。 |
| 403 | InvalidParameter.InvalidEniQueueNumber | %s | 彈性網卡佇列數有誤,具體資訊請參見錯誤訊息 %s 預留位置的實際回傳結果。 |
| 403 | HibernationConfigured.InstanceOperationForbidden | The operation is not permitted due to limit of the hibernation configured instance. | 不符合開啟休眠選項的執行個體的相關限制,操作不被允許。 |
| 403 | InvalidOperation.MaxModifyOnlineNumberExceeded | The specified instance has reached the maximum number of modify online attempts and needs to be rebooted. | |
| 403 | InvalidOperation.RebootingRequired | The specified instance needs to be rebooted. | |
| 403 | InvalidOperation.OSTypeNotSupported | The specified OS type is not supported. | |
| 403 | OperationDenied.UnpaidOrder | The specified instance has unpaid order. | 指定的執行個體 ID 已存在未支付訂單,您可以登入 ECS 管理主控台支付。 |
| 403 | InvalidDisk.DetachedSystemDisk | The specified resource is/has a detached system disk %s , not support current operation. | 指定的磁碟是一塊被卸載的系統磁碟,不支援目前操作。 |
| 403 | InvalidDataDiskCategory.ValueNotSupported | The specified Category of Data Disk is not valid. | 指定參數 DataDisk.Category 錯誤。 |
| 403 | InvalidDiskCategory.NotSupported | The upgrade operation of instance does not support this category of disk. | 指定的雲端硬碟類型在當前可用區不支援。請修改雲端硬碟類型或更換可用區並重試。 |
| 403 | InvalidOperation.InstanceTypeSecureBootUnsupported | The instance type does not support secure boot. | 執行個體規格不支援安全啟動。 |
| 404 | InvalidRegionId.NotFound | The specified RegionId does not exist. | 地域資訊錯誤。 |
| 404 | BillingMethodNotFound | The account has not chosen any billing method. | 該阿里雲帳號沒有選擇任何計費方式。 |
| 404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | 指定的執行個體 ID 無效。 |
| 503 | LimitedOperation.ServiceUnavailable | The service is currently unavailable. Please try again later. | 目前服務不可用。請稍後重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。