重裝一臺輕量型云主機
更新時間 2024-12-13 18:52:44
最近更新時間: 2024-12-13 18:52:44
分享文章
重裝一臺輕量型云主機
接口功能介紹
該接口提供用戶重裝一臺輕量型云主機功能,通過填寫相應云主機ID、鏡像ID對輕量云主機進行重裝。
準備工作:
??構造請求:在調用前需要了解如何構造請求,詳情查看構造請求
??認證鑒權:openapi請求需要進行加密調用,詳細查看認證鑒權
注意事項:
??異步接口:該接口為異步接口,請求過后會拿到任務ID(jobID),后續可以調用來查詢操作是否成功
接口約束
??1. 確保當前請求資源池下,該輕量型云主機、鏡像存在(即instanceID、imageID真實存在且與regionID相對應)
??2. 輕量云主機需要處于關機狀態(stopped),您可以調用查詢結果中的instanceStatus字段來確認當前輕量型云主機狀態
??3. 若當前輕量型云主機存在系統盤快照,不允許執行重裝操作,您可以調用輸入當前云主機系統盤ID,來查詢是否存在系統盤快照
??4. 確保云主機上的硬盤均處于已掛載狀態(in-use),您可以調用查詢當前云硬盤狀態
??5. 重裝鏡像大小不可大于當前云主機系統盤,您可以分別調用和查詢當前云硬盤大小與鏡像大小
URI
POST /v4/ecs/lite/rebuild-instance
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID,您可以查看地域和可用區來了解資源池 獲取: 查 |
bb9fdb42056f11eda1610242ac110002 | |
| instanceID | 是 | String | 云主機ID,您可以查看彈性云主機了解云主機的相關信息 獲取: 查 創 創 |
adc614e0-e838-d73f-0618-a6d51d09070a | |
| password | 是 | String | 用戶密碼,滿足以下規則: 長度在8-30個字符; 必須包含大寫字母、小寫字母、數字以及特殊符號中的三項; 特殊符號可選:()`~!@#$%^&*_-+=|{}[]:;'<>,.?/\且不能以斜線號 / 開頭; 不能包含3個及以上連續字符; Linux鏡像不能包含鏡像用戶名(root)、用戶名的倒序(toor)、用戶名大小寫變化(如RoOt、rOot等); Windows鏡像不能包含鏡像用戶名(Administrator)、用戶名大小寫變化(adminiSTrator等) |
rebuildTest01 | |
| imageID | 否 | String | 鏡像ID,您可以查看鏡像概述來了解云主機鏡像 獲取: 查 創 注:不填默認以原鏡像進行重裝 |
b1d896e1-c977-4fd4-b6c2-5432549977be |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼(800為成功,900為失敗) | 800 | |
| errorCode | String | 錯誤碼,為product.module.code三段式碼 | Openapi.PatternCheck.NotValid | |
| error | String | 錯誤碼,為product.module.code三段式碼 | Openapi.PatternCheck.NotValid | |
| message | String | 失敗時的錯誤描述,一般為英文描述 | SUCCESS | |
| description | String | 失敗時的錯誤描述,一般為中文描述 | 成功 | |
| returnObj | Object | 成功時返回的數據 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| jobID | String | 重裝任務ID,您可以調用來查詢操作是否成功。 注:當免費鏡像重裝時,返回該參數;當付費鏡像重裝時,不返回該參數 |
a8e88ab8-888e-8888-8b88-c8f88a88e8bf |
請求示例
請求頭header
無
請求體body
示例1: 使用原鏡像進行重裝云主機
在華東1資源池以原鏡像重裝一臺云主機
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"instanceID": "adc614e0-e838-d73f-0618-a6d51d09070a",
"password": "rebuildTest01"
}
示例2:使用新鏡像進行重裝云主機
在華東1資源池使用新鏡像進行重裝云主機
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"instanceID": "adc614e0-e838-d73f-0618-a6d51d09070a",
"password": "rebuildTest01",
"imageID": ""9021e932-8074-48ca-aa18-4920ae891f82
}
響應示例
{
"returnObj": {
"jobID": "a8e88ab8-888e-8888-8b88-c8f88a88e8bf"
},
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 表示請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Openapi.PatternCheck.NotValid | 請求參數無效 |
| Ecs.RegionInfo.Empty | 查詢資源池信息為空或資源池不存在,請確認資源池ID是否有效 |
| Ecs.RegionInfo.AccessFailed | 查詢資源池失敗,請重試。如果多次嘗試失敗,請提交工單 |
| Ecs.RegionInfo.DataDamaged | 查詢資源池信息不符預期,請重試。如果多次嘗試失敗,請提交工單 |
| LiteEcs.RegionVersion.NotSupport | 當前API不支持該資源池,請切換資源池重試 |
| Openapi.EcsWorkorder.AccessFailed | 查詢云主機失敗,請重試。如果多次嘗試失敗,請提交工單 |
| Ecs.Instance.NotFound | 云主機不存在,請確認云主機ID是否有效 |
| Ecs.Instance.StatusNotValid | 云主機沒有處于["stopped"]狀態之一,請再次確認云主機狀態 |
| Ecs.Volume.StatusNotValid | 云主機存在磁盤狀態不合法,請確認磁盤狀態 |
| Ecs.Instance.HasSnapshot | 云主機存在系統盤快照 |
| Ecs.Image.OverSize | 鏡像大小不可超過系統盤大小 |
| Openapi.EcsCheck.UnknownError | 云主機檢查失敗,請重試。如果多次嘗試失敗,請提交工單 |
| Ecs.Instance.ActionFailed | 云主機執行動作失敗,請重試。如果多次嘗試失敗,請提交工單 |
| Ecs.Image.NotFound | 鏡像不存在或不符合要求,請確認鏡像信息是否正確 |