All Products
Search
Document Center

Elastic Desktop Service:ModifyDesktopGroup

Last Updated:Jun 11, 2026

Modifies a shared cloud computer group.

Operation description

After you create a shared cloud computer group, the system automatically provisions cloud computers in the group based on its auto scaling policy and end-user connections. All cloud computers in the group use the same cloud computer template and security policy. You can modify the group’s configuration as needed, such as the group name, cloud computer template, and associated policies.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The region ID. Call DescribeRegions to get a list of regions that WUYING Workspace supports.

cn-hangzhou

DesktopGroupId

string

Yes

The ID of the shared cloud computer group.

dg-2i8qxpv6t1a03****

OwnBundleId

string

No

The cloud computer template ID.

b-7t275tpgjueeu****

PolicyGroupId

string

No

The policy ID.

pg-53iyi2aar0nd6****

DesktopGroupName

string

No

shared cloud computer name.

desktopGroupName1

ScaleStrategyId

string

No

The ID of the auto scaling policy group.

Note

This parameter is not yet available.

s-kakowkdl****

KeepDuration

integer

No

The duration to keep a session active after it disconnects. Unit: milliseconds. Valid values range from 180000 (3 minutes) to 345600000 (4 days). A value of 0 means the session is always kept active.

When a session disconnects, either intentionally or unexpectedly, a timer begins. If the user fails to reconnect within this duration, the session is logged off, and any unsaved data is destroyed. If the user reconnects within this duration, they can resume the original session and access the data from before the disconnection.

180000

Comments

string

No

The remarks.

comment

MinDesktopsCount

integer

No

The maximum number of cloud computers that are automatically created in a subscription shared cloud computer group. This parameter is required and takes effect only when ChargeType is set to PrePaid. Default value: 1. Valid values: 0 to the value of MaxDesktopsCount.

1

MaxDesktopsCount

integer

No

The maximum number of cloud computers that a pay-as-you-go shared cloud computer group can contain. Valid values: 0 to 500.

10

AllowAutoSetup

integer

No

Specifies whether to enable automatic creation of cloud computers in a subscription shared cloud computer group. This parameter is required and takes effect only when ChargeType is set to PrePaid.

Valid values:

  • 0 :

    No

  • 1 :

    Yes

1

AllowBufferCount

integer

No

The number of cloud computers to reserve in a pay-as-you-go shared cloud computer group. This parameter is required and takes effect only when ChargeType is set to PostPaid. Valid values:

  • 0: No cloud computers are reserved.

  • N: N cloud computers are reserved (1 ≤ N ≤ 100).

Note

If you do not reserve any cloud computers, the system must create and start one when an end user requests a connection. This process takes longer. Reserve a specific number of cloud computers to ensure a good user experience.

1

ResetType

integer

No

The reset type for the cloud computers.

Valid values:

  • 0 :

    Do not reset.

  • 1 :

    Reset only the system disk.

  • 2 :

    Reset only the user disk.

  • 3 :

    Reset both the system disk and the user disk.

0

LoadPolicy

integer

No

The load balancing policy for a multi-session shared cloud computer group that contains multiple cloud computers.

Note

This parameter is not yet available.

Valid values:

  • 0 :

    Depth-first

  • 1 :

    Breadth-first

0

BindAmount

integer

No

The number of concurrent sessions that each cloud computer in a multi-session shared cloud computer group can support.

Note

This parameter is not yet available.

2

ImageId

string

No

The image ID.

desktopimage-windows-server-2016-64-ch

Classify

string

No

The type of the shared cloud computer group.

Note

This parameter is not yet available.

Valid values:

  • teacher :

    A shared cloud computer group for teachers

  • student :

    A shared cloud computer group for students

teacher

RatioThreshold

number

No

The session usage threshold. This threshold is a condition for triggering auto scaling in a multi-session shared cloud computer group. The session usage is calculated using the following formula:

Session usage = Number of active sessions / (Total number of cloud computers × Maximum number of sessions per cloud computer) × 100%

When the session usage reaches this threshold, new cloud computers are created. If the session usage is below this threshold, idle cloud computers are deleted.

Note

This parameter is not yet available.

0.85

ConnectDuration

integer

No

The maximum duration of a session. When the session duration reaches this value, the session is automatically disconnected. Unit: milliseconds. Valid values: 900000 (15 minutes) to 345600000 (4 days).

900000

IdleDisconnectDuration

integer

No

The maximum idle time for a session. If there is no keyboard or mouse input within this time, the session disconnects. Unit: milliseconds. Valid values: 360000 (6 minutes) to 3600000 (60 minutes).

Thirty seconds before the session disconnects, the end user receives a message to save their data. The end user must save their data to prevent data loss.

Note

This parameter is applicable only to cloud computers with an image version of 1.0.2 or later.

360000

DisableSessionConfig

boolean

No

Specifies whether to disable session management.

true

StopDuration

integer

No

The idle shutdown time. The cloud computer automatically shuts down when it is idle for this amount of time. If a user connects to a shutdown cloud computer, it automatically starts. Unit: milliseconds.

300000

ProfileFollowSwitch

boolean

No

Specifies whether to enable user data roaming.

Note

This parameter is not yet available.

false

FileSystemId

string

No

The ID of the NAS file system used for user data roaming.

Note

This parameter is not yet available.

04f314****

PolicyGroupIds

array

No

The list of policy group IDs.

string

No

The policy group ID.

pg-gx2x1dhsmthe9****

BuyDesktopsCount

integer

No

  • For a subscription shared cloud computer group: the number of cloud computers to purchase. Valid values: 0 to 200.

  • For a pay-as-you-go shared cloud computer group: the minimum number of cloud computers to create in the pool. Default value: 1. Valid values: 0 to the value of MaxDesktopsCount.

5

DeleteDuration

integer

No

Response elements

Element

Type

Description

Example

object

The response object.

RequestId

string

The request ID.

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

Examples

Success response

JSON format

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.