更換一臺(tái)ECS實(shí)例的操作系統(tǒng)。更換后系統(tǒng)盤的云盤ID將發(fā)生變化，原云盤會(huì)被釋放。
接口說(shuō)明
調(diào)用該接口前請(qǐng)您仔細(xì)閱讀更換操作系統(tǒng)（系統(tǒng)盤）。
更換系統(tǒng)盤時(shí)，您需要注意：
-
不支持變更系統(tǒng)盤計(jì)費(fèi)方式。
-
不支持更換系統(tǒng)盤的云盤類型。
-
系統(tǒng)盤掛載的 ECS 實(shí)例不能有未支付的訂單。
-
實(shí)例的狀態(tài)必須為已停止（
Stopped）狀態(tài)。說(shuō)明 僅適用于專有網(wǎng)絡(luò) VPC 類型實(shí)例。如果 ECS 實(shí)例為按量付費(fèi)計(jì)費(fèi)模式，且開(kāi)啟默認(rèn)啟用節(jié)省停機(jī)模式，為防止地域范圍內(nèi)的 ECS 實(shí)例庫(kù)存不足，引起的更換系統(tǒng)盤后無(wú)法重啟實(shí)例。您需要在停止該實(shí)例時(shí)設(shè)置為普通停機(jī)模式。具體操作，請(qǐng)參見(jiàn) StopInstance 。 -
ECS 實(shí)例不能被安全鎖定，即實(shí)例的
OperationLocks參數(shù)值包含"LockReason": "security"。更多信息，請(qǐng)參見(jiàn)安全鎖定時(shí)的 API 行為。 -
您可以通過(guò)參數(shù)
SystemDisk.Size重新指定系統(tǒng)盤的容量大小。
更換系統(tǒng)盤后，建議您通過(guò)以下任一方式驗(yàn)證是否更換成功：
-
通過(guò) DescribeDisks 接口查詢新系統(tǒng)盤的狀態(tài)。如果已掛載實(shí)例，則表示更換系統(tǒng)盤的操作已完成。
-
通過(guò) DescribeInstances 接口查詢更換系統(tǒng)盤的實(shí)例的狀態(tài)。如果返回值
OperationLocks為空，則表示更換系統(tǒng)盤的操作已完成。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語(yǔ)句的Action元素中使用，用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別：是指每個(gè)操作的訪問(wèn)級(jí)別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| ecs:ReplaceSystemDisk | update | *Disk acs:ecs:{#regionId}:{#accountId}:disk/{#diskId}*Image acs:ecs:{#regionId}:{#accountId}:image/{#imageId}*Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId} |
| 無(wú) |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | 指定實(shí)例的 ID。 說(shuō)明
發(fā)起請(qǐng)求之前請(qǐng)確保目標(biāo)實(shí)例狀態(tài)為 已停止（Stopped）。
| i-bp67acfmxazb4ph**** |
| ImageId | string | 否 | 重置系統(tǒng)時(shí)使用的鏡像 ID。 未設(shè)置 | m-bp67acfmxazb4ph**** |
| SystemDisk.Size | integer | 否 | 新的系統(tǒng)盤容量，單位為 GiB。取值范圍：
默認(rèn)值：Max{40, 參數(shù) ImageId 對(duì)應(yīng)的鏡像大小} 說(shuō)明
超過(guò) Max{20, 更換前的系統(tǒng)盤容量}的云盤容量部分，將收取額外費(fèi)用。
| 80 |
| ClientToken | string | 否 | 保證請(qǐng)求冪等性。從您的客戶端生成一個(gè)參數(shù)值，確保不同請(qǐng)求間該參數(shù)值唯一。ClientToken 只支持 ASCII 字符，且不能超過(guò) 64 個(gè)字符。更多信息，請(qǐng)參見(jiàn)如何保證冪等性。 | 123e4567-e89b-12d3-a456-426655440000 |
| UseAdditionalService | boolean | 否 | 是否使用阿里云提供的虛擬機(jī)系統(tǒng)配置（Windows：NTP、KMS；Linux：NTP、YUM）。 說(shuō)明
掛載系統(tǒng)盤時(shí)（即設(shè)備名為/dev/xvda）有效。
| true |
| Password | string | 否 | 是否重置 ECS 實(shí)例的用戶名密碼。長(zhǎng)度為 8 至 30 個(gè)字符，必須同時(shí)包含大小寫英文字母、數(shù)字和特殊符號(hào)中的三類字符。特殊符號(hào)可以是： 其中，Windows 實(shí)例不能以斜線號(hào)（/）為密碼首字符。 默認(rèn)值：保持不變。 說(shuō)明
如果傳入 Password參數(shù)，建議您使用 HTTPS 協(xié)議發(fā)送請(qǐng)求，避免密碼泄露。
| EcsV587! |
| PasswordInherit | boolean | 否 | 是否使用鏡像預(yù)設(shè)的密碼。 默認(rèn)值：false。 說(shuō)明
使用該參數(shù)時(shí)，Password 參數(shù)必須為空。同時(shí)您需要確保使用的鏡像已經(jīng)設(shè)置了密碼。
| false |
| KeyPairName | string | 否 | 密鑰對(duì)名稱。 說(shuō)明
該參數(shù)僅對(duì) Linux 系統(tǒng) ECS 實(shí)例生效。您可以為 ECS 實(shí)例綁定一個(gè) SSH 密鑰對(duì)，作為登錄憑證。使用了 SSH 密鑰對(duì)后，用戶名密碼的登錄憑證方式將被禁用。
| testKeyPairName |
| DiskId | string | 否 | 說(shuō)明
該參數(shù)已廢棄，為提高兼容性，建議您使用 ImageId。
| d-bp67acfmxazb4ph**** |
| Platform | string | 否 | 說(shuō)明
已棄用。
| CentOS |
| Architecture | string | 否 | 說(shuō)明
已棄用。
| i386 |
| SecurityEnhancementStrategy | string | 否 | 更換系統(tǒng)盤后，是否免費(fèi)使用云安全中心服務(wù)。取值范圍：
默認(rèn)值：Deactive。 | Active |
| Encrypted | boolean | 否 | 是否加密云盤。取值范圍：
默認(rèn)值：false。 | false |
| KMSKeyId | string | 否 | 系統(tǒng)盤對(duì)應(yīng)的 KMS 密鑰 ID。 | e522b26d-abf6-4e0d-b5da-04b7******3c |
| EncryptAlgorithm | string | 否 | 說(shuō)明
該參數(shù)暫未開(kāi)放使用。
| hide |
| Arn | array<object> | 否 | 該參數(shù)暫未開(kāi)放使用。 | |
| object | 否 | |||
| RoleType | string | 否 | 說(shuō)明
該參數(shù)暫未開(kāi)放使用。
| null |
| Rolearn | string | 否 | 說(shuō)明
該參數(shù)暫未開(kāi)放使用。
| null |
| AssumeRoleFor | long | 否 | 說(shuō)明
該參數(shù)暫未開(kāi)放使用。
| 0 |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"DiskId": "d-bp67acfmxazb4ph****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 400 | LoginAsNonRoot.ImageNotSupport | The specified image does not support login as non-root. | 此鏡像不支持NonRoot登錄。 |
| 400 | InvalidSystemDiskSize.ValueNotSupported | The specified parameter SystemDisk.Size is invalid. | 指定的 SystemDisk.Size 不合法。 |
| 400 | InvalidParameter.Conflict | The specified image does not support the specified instance type. | 指定的鏡像不能用于指定的實(shí)例規(guī)格。 |
| 400 | InvalidSystemDiskSize.ImageNotSupportResize | The specified image does not support resize. | 指定的鏡像不支持?jǐn)U容。 |
| 400 | InvalidSystemDiskSize | The specified parameter SystemDisk.Size is invalid. | 指定的 SystemDisk.Size 不合法。 |
| 400 | InvalidPassword.Malformed | The specified parameter "Password" is not valid. | 指定的參數(shù) Password 不合法 |
| 400 | InvalidPasswordParam.Mismatch | The input password should be null when passwdInherit is true. | 啟用 PasswdInherit 后，用戶名密碼應(yīng)該設(shè)置為空。 |
| 400 | OperationDenied | The specified image contains the snapshot of the data disk,does not support this operation. | 包含了數(shù)據(jù)盤快照的鏡像，不支持此操作。 |
| 400 | InvalidDiskCategory.ValueNotSupported | The specified parameter "DiskCategory" is not valid. | - |
| 400 | InvalidParameter.Conflict | %s | 您輸入的參數(shù)無(wú)效，請(qǐng)檢查參數(shù)之間是否沖突。%s為變量，將根據(jù)調(diào)用API的實(shí)際情況動(dòng)態(tài)返回錯(cuò)誤信息。 |
| 400 | InvalidSystemDiskSize.ValueNotSupported | %s | 當(dāng)前操作不支持設(shè)置的系統(tǒng)盤大小。 |
| 400 | OperationDenied | %s | 拒絕操作。 |
| 400 | InvalidKeyPairName.NotFound | The specified KeyPairName does not exist. | 指定的 KeyPairName 不存在。 |
| 400 | DependencyViolation.IoOptimize | The specified parameter InstanceId is not valid. | 指定的實(shí)例 IO 優(yōu)化配置不合法。 |
| 400 | MissingParameter.Architecture | Architecture should not be null. | 參數(shù) Architecture 不能為空。 |
| 400 | InvalidArchitecture.Malformed | Architecture is not valid. | 您輸入的參數(shù) Architecture 無(wú)效，請(qǐng)查看該參數(shù)格式是否正確。 |
| 400 | MissingParameter.Platform | Platform should not be null. | 參數(shù) Platform 不能為空。 |
| 400 | InvalidPlatform.Malformed | Platform is not valid. | 指定的平臺(tái)無(wú)效。 |
| 400 | InvalidParameter.AllEmpty | %s | 您沒(méi)有輸入任何參數(shù)，請(qǐng)輸入必要的參數(shù)。 |
| 400 | InvalidDiskId.NotFound | The specified disk do not exist. | 指定的磁盤不存在。 |
| 400 | InvalidDatadisk.DiskStatusViolation | The operation is not permitted due to status of the Datadisk. | 當(dāng)前數(shù)據(jù)盤的狀態(tài)不支持此操作。 |
| 400 | InvalidDatadisk.DiskCategoryViolation | The operation is not permitted due to category of the Datadisk. | 該數(shù)據(jù)盤的類型不支持該操作。 |
| 400 | InvalidDatadisk.ChargeTypeViolation | The operation is not permitted due to charge type of the Datadisk. | - |
| 400 | InvalidSystemDiskSize.ValueNotSupported | The specified SystemDiskSize is not valid. | 指定的 SystemDisk.Size 不合法。 |
| 400 | MissingParameter | The input parameter "ImageId" that is mandatory for processing this request is not supplied. | - |
| 400 | InvalidInstance.NotFoundSystemDisk | The specified instance has no system disk. | 指定的實(shí)例沒(méi)有掛載系統(tǒng)盤。請(qǐng)確保指定的實(shí)例已掛載了系統(tǒng)盤。您可以調(diào)用 DescribeInstances 查詢指定實(shí)例的信息。 |
| 400 | InvalidParameter.DiskType | The specified disk type which has kms key can't convert to system disk. | - |
| 400 | DISK_IN_DEDICATED_BLOCK_STORAGE_CLUSTER | The disk in dedicated block storage cluster is not allowed to do this operation. | - |
| 400 | IncorrectDiskStatus.ReplicationStatusNotFound | Disk replication status not found. | - |
| 400 | IncorrectDiskStatus.InReplication | Disk already in replication. | - |
| 400 | InvalidInstanceType.NotSupported | The specified instanceType is not supported by the image architecture. | - |
| 400 | InvalidRegionId.NotSupportReplaceEncryptedSystemDisk | The specified region not support replace encrypted system disk. | - |
| 400 | InvalidStorageClusterId.CapacityNotEnough | The remaining capacity of the current dedicated storage cluster is less than the size of disk. | 磁盤所在專屬存儲(chǔ)集群的可用容量不足 |
| 400 | QuotaExceed.DiskCapacity | The used capacity of disk type has exceeded the quota in the zone, %s. | 指定磁盤類型的已用容量超出可用區(qū)配額限制，您可以前往配額中心查詢和申請(qǐng)?zhí)嵘疟P容量配額。 |
| 403 | LoginAsNonRoot.RegionNotSupport | The specified region does not support login as non-root. | - |
| 403 | InvalidSystemDiskStatus.IsTransfering | The current status of the resource does not support this operation, system disk is transfering. | 當(dāng)前資源的狀態(tài)不支持此操作，請(qǐng)?jiān)傧到y(tǒng)盤停止傳輸數(shù)據(jù)后重試。 |
| 403 | IncorrectDiskStatus | The current disk status does not support this operation. | 當(dāng)前的磁盤不支持此操作，請(qǐng)您確認(rèn)磁盤處于正常使用狀態(tài)，是否欠費(fèi)。 |
| 403 | IncorrectInstanceStatus | The current status of the resource does not support this operation. | 該資源目前的狀態(tài)不支持此操作。 |
| 403 | InstanceLockedForSecurity | The instance is locked due to security. | 您的資源被安全鎖定，拒絕操作。 |
| 403 | ImageNotSubscribed | The specified image has not be subscribed. | 指定的鏡像未在云市場(chǎng)鏡像中訂閱。 |
| 403 | ImageRemovedInMarket | The specified market image is not available, Or the specified user defined image includes product code because it is based on an image subscribed from marketplace, and that image in marketplace includeing exact the same product code has been removed. | 指定的市場(chǎng)鏡像不可用，或者指定的用戶定義鏡像包含產(chǎn)品代碼，因?yàn)樗趶氖袌?chǎng)訂購(gòu)的鏡像，并且市場(chǎng)中包含完全相同的產(chǎn)品代碼的鏡像已被刪除。 |
| 403 | InstanceExpiredOrInArrears | The specified operation is denied as your prepay instance is expired (prepay mode) or in arrears (afterpay mode). | 實(shí)例已過(guò)期或者欠費(fèi)，請(qǐng)您續(xù)費(fèi)或者結(jié)清后再進(jìn)行操作。 |
| 403 | ChargeTypeViolation | The operation is not permitted due to charge type of the instance. | 付費(fèi)方式不支持該操作，請(qǐng)您檢查實(shí)例的付費(fèi)類型是否與該操作沖突。 |
| 403 | DiskCreatingSnapshot | The operation is denied due to a snapshot of the specified disk is not completed yet. | 指定的磁盤正在創(chuàng)建快照。 |
| 403 | IoOptimized.NotSupported | The specified image is not support IoOptimized Instance. | 指定的鏡像不支持 I/O 優(yōu)化型實(shí)例。 |
| 403 | ImageNotSupportInstanceType | The specified image don not support the InstanceType instance. | 指定的鏡像不支持此類實(shí)例規(guī)格。 |
| 403 | QuotaExceed.BuyImage | The specified image is from the image market,You have not bought it or your quota has been exceeded. | 您暫時(shí)不能使用指定的市場(chǎng)鏡像。 |
| 403 | INST_HAS_UNPAID_ORDER | The instance has unpaid order. | 該實(shí)例有未完成的賬單。 |
| 403 | OperationDenied.InstanceCreating | The specified instance is creating. | 指定的實(shí)例已存在。 |
| 403 | DependencyViolation.WindowsInstance | The instance creating is windows, cannot use ssh key pair to login. | - |
| 403 | InvalidParameter.NotMatch | %s | 您輸入的參數(shù)無(wú)效，請(qǐng)檢查參數(shù)之間是否沖突。 |
| 403 | ResourcesNotInSameZone | The specified instance and disk are not in the same zone. | 指定的實(shí)例和磁盤不在同一可用區(qū)。 |
| 403 | ImageNotSupportInstanceType | The specified instanceType is not supported by instance with marketplace image. | 指定的市場(chǎng)鏡像不支持該實(shí)例規(guī)格。 |
| 403 | OperationDenied.UnpaidOrder | The specified instance has unpaid order. | 指定的實(shí)例ID已存在未支付訂單，您可以登錄ECS管理控制臺(tái)支付。 |
| 403 | InvalidHostname.MismatchImage | The hostname of the current instance can not be applied to the image you choose. | - |
| 403 | OperationDenied.ImageNotValid | %s | 當(dāng)前鏡像不支持此操作。 |
| 403 | HibernationConfigured.InstanceOperationForbidden | The operation is not permitted due to limit of the hibernation configured instance. | 不符合開(kāi)啟休眠選項(xiàng)的實(shí)例的相關(guān)限制，操作不被允許。 |
| 403 | InvalidOperation.MultiAttachDisk | Multi attach disk does not support this operation. | 開(kāi)啟多重掛載特性的云盤不支持該操作。 |
| 403 | InvalidRegionId.NotSupportEncryptAlgorithm | The current region does not support creating encrypted disks with EncryptAlgorithm. | - |
| 403 | InvalidRegionId.NotExists | The region not exists. | - |
| 403 | InvalidEncryptAlgorithm | The specified parameter EncryptAlgorithm is not valid. | - |
| 403 | InvalidEncrypted.NotMatchKmsKeyId | The specified parameter Encrypted must be true when KmsKeyId is not empty. | - |
| 403 | InvalidEncrypted.NotMatchEncryptAlgorithm | The specified parameter Encrypted must be true when EncryptAlgorithm is not empty. | - |
| 403 | InvalidParameter.KmsNotEnabled | The specified operation need enable KMS. | 當(dāng)前操作需要開(kāi)啟KMS。 |
| 403 | InvalidParameter.DataEncryptedKeyCreateFailed | Create kms data encrypted key fail. If you need further assistance, you can contact the KMS Technical Support. | 使用KMS主密鑰創(chuàng)建數(shù)據(jù)密鑰失敗，請(qǐng)聯(lián)系KMS值班同學(xué)進(jìn)一步排查。 |
| 403 | InvalidParameter.KMSKeyId.NotFound | The specified KMSKeyId does not exist. | 指定的參數(shù) KMSKeyId 不存在。 |
| 403 | InvalidParameter.KMSKeyId.CMKUnauthorized | This operation for kmsKeyId is forbidden by KMS. If you need further assistance, you can contact the KMS Technical Support. | - |
| 403 | InvalidParameter.KMSKeyId.CMKNotEnabled | The CMK needs to be enabled. | 加密云盤設(shè)置了 KMSKeyId 后，CMK必須處于啟用狀態(tài)。您可以調(diào)用密鑰管理服務(wù)的 DescribeKey 接口查詢指定CMK的相關(guān)信息。 |
| 403 | InvalidParameter.KMSKeyId.KMSUnauthorized | ECS service have no right to access your KMS. | ECS 服務(wù)無(wú)權(quán)訪問(wèn)您的 KMS。 |
| 403 | InvalidKMSKeyId.NotSymmetric | The specified parameter KmsKeyId must be symmetric. | - |
| 403 | InvalidEncrypted.NotMatchKmsKeyId | The specified parameter Encrypted must be true when kmsKeyId is not null. | - |
| 403 | InvalidDiskId.NotSupportReplaceEncryptedSystemDisk | The specified diskId not support replace encrypted system disk. | - |
| 403 | NotSupportSnapshotEncrypted.DiskCategory | The specified disk category does not support creating encrypted system disks or creating encrypted data disks from snapshots. Check the DiskCategory or Encrypted parameter, or check your account for default encryption settings. | 該磁盤類型不支持創(chuàng)建加密系統(tǒng)盤或以快照方式創(chuàng)建加密數(shù)據(jù)盤，請(qǐng)檢查您輸入的磁盤類型、加密參數(shù)，或者檢查您是否做過(guò)賬號(hào)云盤默認(rèn)加密配置。 |
| 403 | InvalidEncrypted.DefaultEncryptionUnsupported | The specified parameter Encrypted must be true when default encryption is enabled. | 開(kāi)啟云盤默認(rèn)加密后新購(gòu)云盤必須為加密云盤. |
| 404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | 指定的InstanceId不存在。 |
| 404 | InvalidInstanceId.NotFound | The specified instance does not exist. | 指定的實(shí)例不存在，請(qǐng)您檢查實(shí)例 ID 是否正確。 |
| 404 | InvalidImageId.NotFound | The specified ImageId does not exist. | 指定的鏡像在該用戶賬號(hào)下不存在，請(qǐng)您檢查鏡像 ID 是否正確。 |
| 404 | InvalidSystemDiskSize.MoreThanMaxSize | The specified SystemDisk.Size parameter exceeds the maximum size. | 指定的系統(tǒng)盤大小超出最大容量。 |
| 404 | InvalidSystemDiskSize.LessThanImageSize | The specified parameter SystemDisk.Size is less than the image size. | 指定的參數(shù) SystemDisk.Size 小于鏡像文件大小數(shù)值。 |
| 404 | InvalidSystemDiskSize.LessThanMinSize | The specified parameter SystemDisk.Size is less than the min size. | 指定的系統(tǒng)盤小于最低容量。 |
| 404 | NoSuchResource | The specified resource is not found. | 指定的資源不存在。 |
| 500 | OperationDenied | Internal Error. | 內(nèi)部錯(cuò)誤。 |
| 500 | InternalError | The request processing has failed due to some unknown error. | 內(nèi)部錯(cuò)誤，請(qǐng)重試。 |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 內(nèi)部錯(cuò)誤，請(qǐng)重試。 |
| 500 | OperationDenied | The specified InstanceType or Zone is not available or not authorized. | 指定的實(shí)例規(guī)格或可用區(qū)不可用或者未授權(quán)。 |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-12-04 | OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 標(biāo)記、OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-06-27 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-05-08 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-01-15 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2021-12-06 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |