All Products
Search

This Product

    Elastic Desktop Service:ModifyTemplate

    Document Center

    Elastic Desktop Service:ModifyTemplate

    Last Updated:Sep 17, 2026

    Modifies all parameters of a custom cloud computer template.

    Operation description

    Warning To ensure compatibility with unset parameters and default upgrade logic in the template, this operation uses full parameter update logic. In other words, any parameter that is not specified is treated as being set to empty.

    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:ModifyTemplate

    update

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    TemplateId

    string

    Yes

    The template ID.

    b-0caoeogs88y*****
    TemplateName

    string

    No

    The name of the template. The name must meet the following requirements:

    • The name must be 2 to 126 characters in length and can contain letters and Chinese characters.

    • The name must start with a letter or a Chinese character. The name cannot start with http:// or https://.

    • The name can contain letters, digits, Chinese characters, colons (:), underscores (_), or hyphens (-). Periods (.) are not supported.

    MyCloudComputerTemplate001
    Description

    string

    No

    The instance name.

    wework-aim-test
    SystemDiskSize

    integer

    No

    The description of the template. The description must meet the following requirements:

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

    • The description can contain Chinese characters, letters, digits, spaces, and special characters. Line breaks are supported.

    testDescription
    SystemDiskPerformanceLevel

    string

    No

    The size of the system cloud disk. Unit: GiB. Valid values: 40 to 500, in increments of 10 GiB.

    Note

    The system cloud disk size cannot be smaller than the size of the configured image.

    Valid values:

    • PL1 :

      ESSD PL1

    • PL0 :

      ESSD PL0

    • AutoPL :

      ESSD AutoPL.

    80
    DataDiskList

    array<object>

    No

    The type of the system cloud disk.

    Note

    Only high frequency and GPU-accelerated cloud computer specifications support ESSD cloud disks.

    AutoPL

    object

    No

    PerformanceLevel

    string

    No

    The performance level of the data cloud disk. Default value: AutoPL.

    Valid values:

    • PL1 :

      ESSD PL1

    • PL0 :

      ESSD PL0

    • AutoPL :

      ESSD AutoPL.

    AutoPL
    Size

    integer

    No

    The size of the data cloud disk. Unit: GiB. Valid values: 40 to 2040. The value must be a multiple of 10.

    40
    ImageId

    string

    No

    The system cloud disk performance level.

    m-gx2x1dhsmusr2****
    PolicyGroupId

    string

    No

    The cloud computer image ID. You can query the ID on the image management page. System images, custom images, and other image types are supported.

    m-gx2x1dhsmusr2****
    DefaultLanguage

    string

    No

    The ID of the global policy.

    Valid values:

    • en-US :

      English.

    • zh-HK :

      Traditional Chinese (Hong Kong)

    • zh-CN :

      Simplified Chinese.

    • ja-JP :

      Japanese.

    pg-gx2x1dhsmthe9****
    TimerGroupId

    string

    No

    The default language that is set when the cloud computer starts. This parameter takes effect only when a system image is used to create the cloud computer.

    zh-CN
    ResourceGroupId

    string

    No

    The configuration group ID.

    bcc-dweha*****
    ResourceTagList

    array<object>

    No

    The resource group ID.

    rg-a5fqjjqaejt***

    object

    No

    Key

    string

    No

    The tag key.

    department
    Value

    string

    No

    The tag value.

    design
    RegionConfigList

    array<object>

    No

    The cloud computer tags in key-value format. You can specify up to 20 tags.

    object

    No

    OfficeSiteId

    string

    No

    The office network ID.

    cn-hangzhou+dir-709****
    RegionId

    string

    No

    The region ID. You can call DescribeRegions to query the list of regions supported by Elastic Desktop Service.

    cn-beijing
    ResourceInstanceType

    string

    No

    The cloud computer specification ID.

    eds.enterprise_office.8c16g
    SnapshotPolicyId

    string

    No

    The ID of the automatic snapshot policy.

    sp-35fvn8m2*****
    SubnetId

    string

    No

    The subnet ID.

    vsw-adjrehad1****
    VirtualNodePoolId

    string

    No

    vnp-0bz55ic*******
    VolumeEncryptionEnable

    boolean

    No

    Specifies whether to enable disk encryption.

    Valid values:

    • false :

      Disabled. [Default value]

    • true :

      Enabled.

    false
    VolumeEncryptionKey

    string

    No

    The ID of the KMS key used when disk encryption is enabled.

    a7b3c0c8-b3a2-4876-b1cc-116dddc9****
    SiteConfigList

    array<object>

    No

    The region-specific template configurations. You can specify multiple configurations. The configuration that matches the specific region is used.

    Note

    You can specify configurations for up to 20 regions.

    object

    No

    AppRuleId

    string

    No

    The application control policy ID.

    bwr-5a5371e0*******
    SiteId

    string

    No

    The site name.

    mainland
    ChargeType

    string

    No

    The site configuration management.

    Valid values:

    • PostPaid :

      pay-as-you-go.

    • PrePaid :

      subscription.

    PrePaid
    Period

    integer

    No

    The billing method of the cloud computer.

    PrePaid
    PeriodUnit

    string

    No

    The subscription duration of the subscription cloud computer. This parameter takes effect and is required only when ChargeType is set to PrePaid. The unit is specified by PeriodUnit.

    • If PeriodUnit is set to Month, valid values:

      • 1

      • 2

      • 3

      • 6

    • If PeriodUnit is set to Year, valid values:

      • 1

      • 2

      • 3

      • 4

      • 5

    Valid values:

    • Month :

      month.

    • Year :

      year.

    • Week :

      week.

    1
    AutoPay

    boolean

    No

    The unit of the subscription duration for the subscription billing method.

    Month
    AutoRenew

    boolean

    No

    Specifies whether automatic payment is enabled for the subscription order.

    UserDuration

    integer

    No

    Specifies whether to enable auto-renewal for the subscription cloud computer.

    Valid values:

    • 120 :

      120 hours.

    • 250 :

      250 hours.

    • 360 :

      360 hours.

    120
    PostPaidAfterUsedUp

    boolean

    No

    The duration plan for a single user.

    120

    Response elements

    Element

    Type

    Description

    Example

    object

    BaseResult

    Code

    string

    The execution result. A value of success indicates success. Otherwise, an error message is returned.

    success
    HttpStatusCode

    integer

    The HTTP status code.

    200
    Message

    string

    The error message. This parameter is not returned when Code is success.

    success
    RequestId

    string

    The request ID.

    1CBAFFAB-B697-4049-A9B1-67E1FC5F****
    Success

    boolean

    Indicates whether the operation was successful. Valid values: true: The operation was successful. false: The operation failed.

    true

    Examples

    Success response

    JSON format

    {
  "Code": "success",
  "HttpStatusCode": 200,
  "Message": "success",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "Success": true
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.