All Products
Search

This Product

    Elastic Desktop Service:UploadImage

    Document Center

    Elastic Desktop Service:UploadImage

    Last Updated:Jan 05, 2026

    Uploads your custom Windows image.

    Operation description

    Note You can upload only Windows images.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    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:
      • For mandatory resource types, indicate with a prefix of * .
      • 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
    ecd:UploadImagecreate
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID. You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    OssObjectPathstringYes

    The object path of the image file in Object Storage Service (OSS).

    		https://ossbucket:endpoint/object
    ImageNamestringYes

    The name of the image. The name must be 2 to 128 characters in length. The name must start with a letter but cannot start with http:// or https://. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-).

    		Win10_Test
    DescriptionstringNo

    The description of the image. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

    		test description
    OsTypestringNo

    The type of the operating system.

    Valid values:

    • Linux

    • Windows

    		Windows
    GpuCategorybooleanYes

    Specifies whether the image is a GPU-accelerated image.

    		true
    ProtocolTypestringNo

    The protocol type.

    Valid values:

    • ASP: in-house Adaptive Streaming Protocol (ASP)
    		ASP
    DataDiskSizeintegerNo

    The size of the data disk. Valid values: 80 to 500. Unit: GiB.

    		80
    GpuDriverTypestringNo

    The type of the pre-installed GPU driver.

    Valid values:

    • gpu_grid9: This GPU driver is used on cloud computers of the following two specifications: graphics – 4 vCPUs, 23 GiB memory, 4 GiB GPU memory, and graphics – 10 vCPUs, 46 GiB memory, 8 GiB GPU memory.
    • gpu_custom: You can install the driver later.
    • gpu_grid12: This GPU driver is used on graphical cloud computers of specifications other than the following two specifications: graphics – 4 vCPUs, 23 GiB memory, & 4 GiB GPU memory, and graphics – 10 vCPUs, 46 GiB memory, & 8 GiB GPU memory.
    		gpu_grid9
    LicenseTypestringNo

    The type of the license that is used to activate the operating system after the image is imported. Valid values:

    • Auto: Elastic Desktop Service detects the operating system of the image and allocates a license to the operating system. In this mode, the system first checks whether a license allocated by an official Alibaba Cloud channel is specified in the Platform. If a license allocated by an official Alibaba Cloud channel is specified, the system allocates the license to the imported image. If no such license is specified, the BYOL (Bring Your Own License) mode is used.
    • Aliyun: The license that is allocated by an official Alibaba Cloud channel and is specified by Platform is used for the operating system distribution.
    • BYOL: The license that comes with the source operating system is used. When you use the BYOL mode, make sure that your license key is supported by Alibaba Cloud.

    Default value: Auto.

    Note Windows 10 cannot be activated by Alibaba Cloud. Set the LicenseType to BYOL for Windows 10.
    		Auto
    EnableSecurityCheckbooleanNo

    Specifies whether to enable security check.

    		true
    SystemDiskSizestringNo

    The size of the system disk. Unit: GiB.

    Note The system disk must be at least as large as the image.
    		80

    Response parameters

    ParameterTypeDescriptionExample
    object

    The information that is returned.

    ImageIdstring

    The ID of the custom image.

    		m-d4dwr5tgrgvd****
    RequestIdstring

    The ID of the request.

    		2CC66B0A-BA3B-5D87-BFBE-11AAAD7A****

    Examples

    Sample success responses

    JSONformat

    {
  "ImageId": "m-d4dwr5tgrgvd****",
  "RequestId": "2CC66B0A-BA3B-5D87-BFBE-11AAAD7A****"
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2024-11-09The request parameters of the API has changedView Change Details
    2022-06-01The request parameters of the API has changedView Change Details
    2022-02-24Add OperationView Change Details