Automate ENS Node Deployment by Importing Custom Images via API - ENS - Alibaba Cloud - ENS

Imports an image.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ens:ImportImage

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ImageName	string	Yes	The name of the custom image. The name must be 2 to 128 characters long and must start with a letter or a Chinese character. It can contain digits, colons (:), underscores (_), and hyphens (-). The name cannot start with `http://` or `https://`.	Image name
ComputeType	string	Yes	The type of the image. Valid value: `ens_vm` (ENS virtual machine image). Default value: `ens_vm`.	ens_vm
OSSRegion	string	No	The region where the source image is located. Currently, only `cn-beijing` is supported.	cn-beijing
OSSBucket	string	No	The OSS bucket where the image file is stored.	tmp-hybrid
OSSObject	string	No	The name of the image file (object) in the OSS bucket.	image-test
OSType	string	Yes	The type of the operating system. Valid values: windows linux Currently, only `linux` is supported.	linux
Platform	string	No	The operating system distribution. Valid values: centos ubuntu	centos
ImageFormat	string	Yes	The image format. Valid value: `qcow2`.	qcow2
Architecture	string	Yes	The system architecture. Valid value: x86_64	x86_64
OSVersion	string	No	The version of the operating system distribution.	6.8
DiskDeviceMapping	array<object>	No	A list of disk mappings that describe the source of the image file.
	object	No	Specifies the details of a disk mapping.
OSSRegion	string	No	The region where the image is located.	cn-beijing
OSSBucket	string	No	The OSS bucket that stores the image file.	www-cn
OSSObject	string	No	The name (key) of the image file stored in the OSS bucket.	image-bucket
TargetOSSRegionId	string	No	The ID of the target region where the image will be stored. Note Currently, only the cn-beijing and ap-southeast-1 regions are supported.	cn-beijing
LicenseType	string	No

Response elements

Element	Type	Description	Example
	object	Response schema
RequestId	string	The request ID.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
ImageId	string	The image ID.	m-5wn1dh*******b48f440ntvad

Examples

Success response

JSON format

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "ImageId": "m-5wn1dh*******b48f440ntvad"
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.