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