全部產品
Search

搜尋本產品

    Simple Application Server：CreateCustomImage - 建立自訂鏡像

    文件中心

    Simple Application Server：CreateCustomImage - 建立自訂鏡像

    更新時間：Apr 21, 2026

    通過快照建立使用者自訂鏡像。

    介面說明

    自訂鏡像是您通過Simple Application Server的快照建立的鏡像。您可以通過已配置好的自訂鏡像建立更多包含相同配置的Simple Application Server，也可以將自訂鏡像共用至Elastic Compute Service，進而通過共用鏡像建立 ECS 執行個體或更換作業系統。 關於自訂鏡像的更多訊息，請參見自訂鏡像概述。

    建立自訂鏡像之前，您需要先建立Simple Application Server的系統硬碟快照。具體操作，請參見 CreateSnapshot 。

    說明

    如果您建立自訂鏡像時需要伺服器的資料盤資料，請先建立一份伺服器的資料盤快照。

    建立自訂鏡像時，您需要先閱讀以下注意事項：

    • 建立的自訂鏡像所屬地區與對應的Simple Application Server所屬地區相同。

    • 建立的自訂鏡像數量上限為已建立的伺服器數量的 3 倍，但最多不超過 15 個。

    • 只有伺服器的系統硬碟快照可以直接建立自訂鏡像。如果您需要自訂鏡像中包含伺服器的資料盤資料，在建立自訂鏡像的過程中，需要手動選擇對應的資料盤快照。

    • 如果Simple Application Server到期或者退款後釋放，該伺服器對應的自訂鏡像也會隨之釋放。

    • 重設系統或更換鏡像會清除伺服器上的磁碟資料，請您根據需要做好資料備份。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    swas-open:CreateCustomImage

    create

    *CustomImage

    acs:swas-open:{#regionId}:{#accountId}:customimage/*

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    是

    地區 ID。您可以調用 ListRegions 查詢可用地區。

    cn-hangzhou
    ClientToken

    string

    否

    保證請求等冪性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元，且不能超過 64 個字元。更多資訊，請參見如何保證等冪性。

    123e4567-e89b-12d3-a456-426655440000
    InstanceId

    string

    是

    指定的Simple Application Server的執行個體 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****

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
    ImageId

    string

    自訂鏡像 ID。

    m-csaascsaccscs****

    樣本

    正常返回樣本

    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. 指定的參數系統快照不支援建立自訂鏡像。
    500 InternalError An error occurred while processing your request. 內部錯誤，請重試。如果多次嘗試失敗，請提交工單。
    403 IncorrectInstanceStatus The state of the current instance does not support this operation. 當前執行個體的狀態不支援此操作。
    404 InvalidInstanceId.NotFound The specified InstanceId does not exist. 指定的執行個體不存在，請您檢查執行個體ID是否正確。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。