通過快照創建用戶自定義鏡像。
接口說明
自定義鏡像是您通過輕量應用服務器的快照創建的鏡像。您可以通過已配置好的自定義鏡像創建更多包含相同配置的輕量應用服務器,也可以將自定義鏡像共享至云服務器 ECS,進而通過共享鏡像創建 ECS 實例或更換操作系統。 關于自定義鏡像的更多消息,請參見自定義鏡像概述。
創建自定義鏡像之前,您需要先創建輕量應用服務器的系統盤快照。具體操作,請參見 CreateSnapshot 。
創建自定義鏡像時,您需要先閱讀以下注意事項:
-
創建的自定義鏡像所屬地域與對應的輕量應用服務器所屬地域相同。
-
創建的自定義鏡像數量上限為已創建的服務器數量的 3 倍,但最多不超過 15 個。
-
只有服務器的系統盤快照可以直接創建自定義鏡像。如果您需要自定義鏡像中包含服務器的數據盤數據,在創建自定義鏡像的過程中,需要手動選擇對應的數據盤快照。
-
如果輕量應用服務器到期或者退款后釋放,該服務器對應的自定義鏡像也會隨之釋放。
-
重置系統或更換鏡像會清除服務器上的磁盤數據,請您根據需要做好數據備份。
QPS 限制
本接口的單用戶 QPS 限制為 10 次/分鐘。超過限制,API 調用會被限流,這可能會影響您的業務,請合理調用。更多信息,請參見 QPS 限制。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
swas-open:CreateCustomImage | create |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。您可以調用 ListRegions 查詢可用地域。 | cn-hangzhou |
ClientToken | string | 否 | 保證請求冪等性。從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符,且不能超過 64 個字符。更多信息,請參見如何保證冪等性。 | 123e4567-e89b-12d3-a456-426655440000 |
InstanceId | string | 是 | 指定的輕量應用服務器的實例 ID。 | ace0706b2ac4454d984295a94213**** |
ImageName | string | 是 | 自定義鏡像名稱。長度為 2~128 個英文或中文字符,必須以大小寫字母或中文開頭或數字開頭,可以包含數字、半角冒號(:)、下劃線(_)或者短劃線(-)。 默認值:空 | customImage-test |
SystemSnapshotId | string | 否 | 系統盤快照 ID。 | s-acscasca**** |
Description | string | 否 | 鏡像描述信息。 | test |
DataSnapshotId | string | 否 | 數據盤快照 ID。 | s-acscasca**** |
Tag | array<object> | 否 | 標簽列表,最多包含 20 個子項。 | |
object | 否 | 標簽。 | ||
Key | string | 否 | 為自定義鏡像指定的標簽鍵。N 的取值范圍:1~20。 一旦傳入該值,則不允許為空字符串。最多支持 64 個字符,不能以 aliyun 和 acs:開頭,不能包含 http://或者 https://。 | TestKey |
Value | string | 否 | 為自定義鏡像指定的標簽值。N 的取值范圍:1~20。 一旦傳入該值,可以為空字符串。最多支持 64 個字符,不能包含 http://或者 https://。 | TestValue |
ResourceGroupId | string | 否 | 資源組 ID。 | rg-aek2bti7cf7**** |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"ImageId": "m-csaascsaccscs****"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidParam.DataSnapshotIdNotFound | The specified parameter dataSnapshotId is not found. | 指定的數據盤快照不存在。 |
400 | InvalidParam.SystemSnapshotIdNotFound | The specified parameter systemSnapshotId is not found. | 指定的系統盤快照不存在。 |
400 | InvalidParam.IllegalImageName | The specified parameter imageName is illegal. | 指定的鏡像名稱不合法。 |
400 | ImageNameAlreadyExist | The image name already exists. | 鏡像名稱已存在。 |
400 | CustomImageQuotaLimit | The maximum number of custom image in this region is exceeded. | 您的自定義鏡像在該地域下已達上限。 |
400 | InvalidParam.SystemSnapshotIdNotSupport | You cannot create custom images in the specified parameter system snapshotId. | 指定的參數系統快照不支持創建自定義鏡像。 |
403 | IncorrectInstanceStatus | The state of the current instance does not support this operation. | 當前實例的狀態不支持此操作。 |
404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | 指定的實例不存在,請您檢查實例ID是否正確。 |
500 | InternalError | An error occurred while processing your request. | 內部錯誤,請重試。如果多次嘗試失敗,請提交工單。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-08-08 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2024-05-29 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2024-04-17 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-02-20 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2021-10-27 | 新增 OpenAPI | 查看變更詳情 |
2021-10-27 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |