All Products
Search
Document Center

Simple Application Server:CreateCustomImage

Last Updated:Aug 15, 2024

Creates a custom image based on a snapshot of a simple application server.

Operation description

A custom image is created based on a snapshot of a simple application server. You can use a custom image to create multiple simple application servers that have the same configurations. You can also share custom images to ECS and use the shared images to create ECS instances or replace the OSs of existing ECS instances. For more information about custom images, see Overview of custom images.

You must create a system disk snapshot of a simple application server before you create a custom image based on the snapshot. For more information, see CreateSnapshot .

Note If you need the data on the data disk of a simple application server when you create a custom image, create a snapshot for the data disk first.

Before you create a custom image, take note of the following items:

  • The custom image and the corresponding simple application server must reside in the same region.
  • The maximum number of custom images that can be maintained in an Alibaba Cloud account is triple the number of simple application servers in the account. The value cannot be greater than 15.
  • You can directly create a custom image only based on the system disk snapshot of a simple application server. If you want a custom image to contain the data on the data disk of the simple application server, you must select a data disk snapshot when you create the custom image.
  • If a simple application server is released due to expiration or refunds, the custom images that are created based on a snapshot of the server are also released.
  • If you reset a simple application server by changing the application system or OS of the server or replacing the image of the server, the disk data on the server is cleared. Back up the disk data as needed.

QPS limit

You can call this API operation up to 10 times per minute per account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
swas-open:CreateCustomImagecreate
  • CustomImage
    acs:swas-open:{#regionId}:{#accountId}:customimage/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the database. You can call the ListRegions operation to query the most recent region list.

cn-hangzhou
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of ClientToken can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

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

The ID of the simple application server.

ace0706b2ac4454d984295a94213****
ImageNamestringYes

The name of the custom image. The name must be 2 to 128 characters in length, and can contain letters, digits, colons (:), underscores (_), and hyphens (-). The name must start with a letter or a digit. This parameter is empty by default.

customImage-test
SystemSnapshotIdstringNo

The ID of the system disk snapshot.

s-acscasca****
DescriptionstringNo

The description of the custom image.

test
DataSnapshotIdstringNo

The ID of the data disk snapshot.

s-acscasca****
Tagarray<object>No

The tags that you want to add to the custom image. You can specify up to 20 tags.

objectNo

The tags of the custom image.

KeystringNo

The key of tag N that you want to add to the custom image. Valid values of N: 1 to 20.

The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot contain http:// or https://. The tag key cannot start with acs: or aliyun.

TestKey
ValuestringNo

The value of tag N that you want to add to the custom image. Valid values of N: 1 to 20.

The tag value can be an empty string. The tag value can be up to 64 characters in length and cannot contain http:// or https://.

TestValue
ResourceGroupIdstringNo

The resource group ID.

rg-aek2bti7cf7****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

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

The custom image ID.

m-csaascsaccscs****

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "ImageId": "m-csaascsaccscs****"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParam.DataSnapshotIdNotFoundThe specified parameter dataSnapshotId is not found.-
400InvalidParam.SystemSnapshotIdNotFoundThe specified parameter systemSnapshotId is not found.-
400InvalidParam.IllegalImageNameThe specified parameter imageName is illegal.The specified image name is invalid.
400ImageNameAlreadyExistThe image name already exists.The specified image name already exists.
400CustomImageQuotaLimitThe maximum number of custom image in this region is exceeded.The maximum number of custom images within this region has been reached.
400InvalidParam.SystemSnapshotIdNotSupportYou cannot create custom images in the specified parameter system snapshotId.-
403IncorrectInstanceStatusThe state of the current instance does not support this operation.-
404InvalidInstanceId.NotFoundThe specified InstanceId does not exist.-
500InternalErrorAn error occurred while processing your request.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-08-08The Error code has changed. The request parameters of the API has changedView Change Details
2024-05-29The Error code has changed. The request parameters of the API has changedView Change Details
2024-04-17The Error code has changedView Change Details
2024-02-20The Error code has changed. The request parameters of the API has changedView Change Details
2021-10-27Add OperationView Change Details
2021-10-27The Error code has changedView Change Details