本接口用于修改一臺包年包月ECS實例的實例規格,支持您升級或者降低實例規格,修改后的實例規格在實例整個生命周期內生效。
接口說明
請確保在使用該接口前,已充分了解 ECS 產品的收費方式、價格以及降配退款規則。
本接口屬于異步操作,等待約 5~10 秒后配置變更完成。升級或者降低包年包月 ECS 實例規格前,您可以通過 DescribeResourcesModification 查詢當前實例支持變配的實例規格。
注意事項
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ecs:ModifyPrepayInstanceSpec | update | *Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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。 說明
AutoPay 置為false ,此時會生成未支付訂單,您可以登錄 ECS 管理控制臺自行支付。OperatorType 被置為downgrade 時,將忽略參數AutoPay 。 | 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。 說明
若實例處于已停止狀態,即使您設置了 RebootWhenFinished=true ,也會保持原狀態不變,并不會執行任何操作。
| false |
ModifyMode | string | 否 | 說明
該參數暫未開放使用。
| null |
Disk | array<object> | 否 | 說明
該參數暫未開放使用。
| |
object | 否 | 說明
該參數暫未開放使用。
| ||
DiskId | string | 否 | 說明
該參數暫未開放使用。
| null |
Category | string | 否 | 說明
該參數暫未開放使用。
| null |
PerformanceLevel | string | 否 | 說明
該參數暫未開放使用。
| null |
返回參數
示例
正常返回示例
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. | 不支持指定的InstanceType。 |
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. | 請求被流控,請稍后重試。 |
400 | Account.Arrearage | Your account has an outstanding payment. | 您的賬號存在未支付的款項。 |
400 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | 指定的InstanceId不存在。 |
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. | 與相同 ClientToken 的請求參數不符合。 |
400 | IdempotenceParamNotMatch | %s | 冪等參數不匹配。 |
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 | InvalidInstanceType.ValueNotSupported | %s | 該操作暫不支持指定的實例類型。 |
400 | InvalidParameter | %s | 無效的參數。 |
400 | OperationDenied | The current user does not support this operation. | 您使用的賬號暫不支持此操作。 |
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. | 指定的實例為臨時升級中(即調用ModifyPrepayInstanceSpec時設置了EndTime參數)的實例,暫不支持查詢。 |
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. | - |
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拓撲類型不支持熱變配 |
403 | OperationDenied.NoStock | The specified instance is out of usage. | 指定的實例庫存不足。 |
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 | InvalidParameter.InstanceId | %s | 指定的參數 InstanceId 無效。 |
403 | OperationDenied | %s | 拒絕操作。 |
403 | ImageNotSupportInstanceType | The specified instanceType is not supported by instance with marketplace image. | 指定的市場鏡像不支持該實例規格。 |
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 | OperationDenied.NoStock | The resource is out of stock in the specified zone. Please try other types, or choose other regions and zones. | 指定的資源在指定可用區中無貨。請嘗試其他類型,或選擇其他可用區和地域。 |
403 | InvalidOperation.EniCountExceeded | %s | - |
403 | InvalidOperation.Ipv4CountExceeded | %s | IPv4 數量達到上限,導致該操作無效。 |
403 | InvalidOperation.Ipv6CountExceeded | %s | IPv6 數量達到上限,導致該操作無效。 |
403 | InvalidOperation.Ipv6NotSupport | %s | IPv6不支持當前操作。 |
403 | InvalidOperation.Ipv4NotSupport | %s | - |
403 | InvalidInstance.NotFoundSystemDisk | The specified instance has no system disk. | 指定的實例沒有掛載系統盤。請確保指定的實例已掛載了系統盤。您可以調用 DescribeInstances 查詢指定實例的信息。 |
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 | QuotaExceed.ElasticQuota | The number of the specified ECS instances has exceeded the quota of the specified instance type. | 您在當前地域選擇的實例規格所要創建的臺數超出系統限額,您可以選擇其他地域、實例規格或減少臺數重新購買,也可以前往ECS管理控制臺或配額中心申請提高限額。 |
403 | QuotaExceed.ElasticQuota | The number of vCPUs assigned to the ECS instances has exceeded the quota in the zone. | 您的全實例規格vCPU配額超出系統限額,您可以前往ECS管理控制臺或配額中心申請提高限額。 |
403 | QuotaExceed.ElasticQuota | The number of the specified ECS instances has exceeded the quota of the specified instance type, or the number of vCPUs assigned to the ECS instances has exceeded the quota in the zone. | 您在當前地域選擇的實例規格所要創建的臺數超出系統限額,或者全實例規格vCPU配額超出系統限額,您可以前往ECS管理控制臺或配額中心申請提高限額。 |
403 | InvalidResourceType.NotSupported | %s | - |
403 | InvalidOperation.MaxEniQueueNumberExceeded | %s | 彈性網卡隊列數超過上限,具體信息請參見錯誤信息%s占位符的實際返回結果。 |
403 | InvalidOperation.ExceedInstanceTypeQueueNumber | %s | 彈性網卡隊列總數超過上限,具體信息請參見錯誤信息%s占位符的實際返回結果。 |
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. | 指定的數據盤磁盤類型不支持 |
404 | InvalidRegionId.NotFound | The specified RegionId does not exist. | 指定的地域 ID 不存在。 |
404 | BillingMethodNotFound | The account has not chosen any billing method. | 該阿里云賬號沒有選擇任何計費方法。 |
500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 內部錯誤,請重試。 |
500 | InternalError | The request processing has failed due to some unknown error. | 內部錯誤,請重試。 |
500 | ImageOrderFailed | Create marketplace image order failed. | 創建云市場訂單失敗,請提交工單處理。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-10-14 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-12-14 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-10-18 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-07-28 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-07-21 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-06-28 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-06-28 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-05-08 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-04-13 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-04-07 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |