功能介紹
切換彈性 云服務(wù)器 操作系統(tǒng)。支持彈性云服務(wù)器數(shù)據(jù)盤不變的情況下，使用新 鏡像 重裝系統(tǒng)盤。
本接口為異步接口，當(dāng)前切換彈性云服務(wù)器操作系統(tǒng)請求下發(fā)成功后會返回job_id，此時切換彈性云服務(wù)器操作系統(tǒng)并沒有立即完成，需要通過調(diào)用查詢?nèi)蝿?wù)的執(zhí)行狀態(tài)查詢job狀態(tài)，當(dāng)Job狀態(tài)為 SUC CES S 時代表云服務(wù)器操作系統(tǒng)切換成功。
調(diào)用該接口后，系統(tǒng)將卸載系統(tǒng)盤，然后使用新鏡像重新創(chuàng)建系統(tǒng)盤，并掛載至彈性云服務(wù)器，實現(xiàn)切換操作系統(tǒng)功能。
接口約束
- 該接口僅支持安裝了Cloud-init或Cloudbase-init的鏡像。如果鏡像未安裝Cloud-init或者Cloudbase-init，請使用 切換彈性云服務(wù)器操作系統(tǒng)（未安裝Cloud-init）接口。
- 不包含系統(tǒng)盤的彈性云服務(wù)器不能切換操作系統(tǒng)。
- 執(zhí)行切換操作系統(tǒng)任務(wù)時，請勿并行執(zhí)行其他任務(wù)，否則可能會引起切換操作系統(tǒng)失敗。
調(diào)試
您可以在API Explorer中調(diào)試該接口。
請求消息
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
adminpass |
否 |
String |
云服務(wù)器管理員帳戶的初始登錄密碼。 其中，Windows管理員帳戶的用戶名為Administrator，Linux管理員賬戶的用戶名為root。 建議密碼復(fù)雜度如下：
說明：
|
|
keyname |
否 |
String |
密鑰名稱。 密鑰可以通過密鑰創(chuàng)建接口進(jìn)行創(chuàng)建（請參見創(chuàng)建和導(dǎo)入SSH密鑰），或使用SSH密鑰查詢接口查詢已有的密鑰（請參見查詢SSH密鑰列表 ）。 |
|
userid |
否 |
String |
用戶ID。當(dāng)傳入keyname參數(shù)時，優(yōu)先使用本參數(shù)設(shè)置的userid，若userid為空，默認(rèn)使用當(dāng)前token中的userid。 查看用戶ID方法：
|
|
imageid |
是 |
String |
切換系統(tǒng)所使用的新鏡像的ID，格式為UUID。 |
|
metadata |
否 |
Object |
切換云服務(wù)器的元數(shù)據(jù)。 |
|
mode |
否 |
String |
取值為withStopServer ，支持開機(jī)狀態(tài)下切換彈性云服務(wù)器操作系統(tǒng)。 mode取值為withStopServer時，對開機(jī)狀態(tài)的彈性云服務(wù)器執(zhí)行切換操作系統(tǒng)操作，系統(tǒng)自動對云服務(wù)器先執(zhí)行關(guān)機(jī)，再切換操作系統(tǒng)。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
user_data |
否 |
String |
創(chuàng)建云服務(wù)器過程中待注入實例自定義數(shù)據(jù)。支持注入文本、文本文件。 說明：
了解更多實例自定義數(shù)據(jù)注入請參考用戶數(shù)據(jù)注入。 示例： base64編碼前：
base64編碼后：
|
|
__system__encrypted |
否 |
String |
metadata中的表示加密功能的字段，0代表不加密，1代表加密。 該字段不存在時，系統(tǒng)盤默認(rèn)為不加密。 |
|
__system__cmkid |
否 |
String |
用戶主密鑰ID，是metadata中的表示加密功能的字段，與__system__encrypted配合使用。 說明：
請參考查詢密鑰列表，通過HTTPS請求獲取密鑰ID。 |
響應(yīng)消息
請求示例
- 切換云服務(wù)器操作系統(tǒng)，切換后采用密碼方式登錄鑒權(quán)。
POST https://{endpoint}/v2/{project_id}/cloudservers/{server_id}/changeos { "os-change": { "adminpass": "1qazXSW@", "userid": "7e25b1da389f4697a79df3a0e5bd494e", "imageid": "e215580f-73ad-429d-b6f2-5433947433b0", "mode": "withStopServer" } }
- 切換云服務(wù)器操作系統(tǒng)，切換后采用密鑰方式登錄鑒權(quán)。
POST https://{endpoint}/v2/{project_id}/cloudservers/{server_id}/changeos { "os-change": { "keyname": "KeyPair-350b", "userid": "7e25b1da389f4697a79df3a0e5bd494e", "imageid": "e215580f-73ad-429d-b6f2-5433947433b0" } }
返回值
請參考通用請求返回值。
錯誤碼
請參考錯誤碼。
