Create a custom cloud computer template using CreateBundle - Elastic Desktop Service - Alibaba Cloud - Elastic Desktop Service

Creates a custom cloud computer template.

Operation description

Cloud computer templates include system templates and custom templates. A system template is the default template provided by Alibaba Cloud. You can call this operation to create a custom template.

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

ecd:CreateBundle

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
ImageId	string	Yes	The ID of the image.	m-4zfb6zj728hhr****
DesktopType	string	Yes	The instance type of the cloud computers. You can call the DescribeBundles operation to query cloud computer templates and obtain the instance types supported by the cloud computers from the `DesktopType` response parameter. Note If you want the template to use a non-GPU-accelerated image, you can only select a non-GPU-accelerated instance type. If you want the template to use a GPU-accelerated image, you can only select a GPU-accelerated instance type.	eds.enterprise_office.2c4g
RootDiskSizeGib	integer	Yes	The size of the system disk. Unit: GiB. The value of this parameter must be consistent with the system disk size supported by the cloud computer instance type. For more information, see Overview.	80
BundleName	string	No	The name of the cloud computer template.	testBundleName
Description	string	No	The description of the cloud computer template.	test
Language	string	No	The OS language. This parameter is available only for system images. Valid values: zh-CN: Simplified Chinese zh-HK: Traditional Chinese (Hong Kong) en-US: American English ja-JP: Japanese Valid values: en-US : zh-HK : zh-CN : ja-JP :	zh-CN
UserDiskSizeGib	array	Yes	The data disk sizes. You can configure only one data disk.	70
	integer	No	The data disk size. You can configure only one data disk. Unit: GiB. The value of this parameter must be consistent with the data disk size supported by the cloud computer instance type. For more information, see Overview. Note The value of the UserDiskSizeGib parameter in the template must be greater than the value of the DataDiskSize parameter in the image.	70
RootDiskPerformanceLevel	string	No	The performance level (PL) of the system disk. When the cloud computer instance type that is specified by the DesktopType parameter is set to a graphical instance type or instance type with a high clock speed, you can set the performance level of the disks. For more information about the differences among disks at different PLs, see Enhanced SSDs. Valid values: PL1 PL0 PL3 PL2 Valid values: PL1 : PL1 PL0 : PL0 PL3 : PL3 PL2 : PL2	PL1
UserDiskPerformanceLevel	string	No	The PL of the data disk. When the cloud computer instance type that is specified by the DesktopType parameter is set to a graphical instance type or instance type with a high clock speed, you can set the performance level of the disks. For more information about the differences among disks at different PLs, see Enhanced SSDs. Valid values: PL1 PL0 PL3 PL2 Valid values: PL1 : PL1 PL0 : PL0 PL3 : PL3 PL2 : PL2	PL1

Response elements

Element	Type	Description	Example
	object	Schema of response.
BundleId	string	The ID of the cloud computer template.	b-cezrnfgecbich****
RequestId	string	The ID of the request.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Success response

JSON format

{
  "BundleId": "b-cezrnfgecbich****",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.