Elastic Desktop Service:CreateDesktopGroup

The ID of the region. You can call the DescribeRegions operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.

The ID of the cloud computer template.

The ID of the office network.

The ID of the policy.

The name of the shared group. The name can be up to 30 characters in length and can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). It must start with a letter but cannot start with http:// or https://.

The ID of the directory.

The ID of the scaling policy.

The ID of the virtual private cloud (VPC).

The default number of cloud computers that you want to create at the same time in the shared group. Default value: 1.

The duration for which each session remains active after disconnection. Valid values: 180000 (3 minutes) to 345600000 (4 days). Unit: milliseconds. If you set this parameter to 0, the session is permanently retained after disconnection.

When a session is disconnected, take note of the following items: 1. If the end user does not resume the session within the specified duration, the session will close, and all unsaved data will be cleared. 2. If the end user resumes the session within the specified duration, the session data will remain accessible for continued use.

The billing method of the shared group.

Valid values:

• PostPaid: pay-as-you-go.
• PrePaid: subscription.

The subscription duration of the shared group. This parameter is required if you set ChargeType to PrePaid. You must specify the subscription duration unit by using PeriodUnit.

• If you set PeriodUnit to Month, valid values of this parameter:

  • 1
  • 2
  • 3
  • 6

• If you set PeriodUnit to Year, valid values of this parameter:

  • 1
  • 2
  • 3
  • 4
  • 5

The unit of the subscription duration.

The session type of the shared group.

Valid values:

• 0: single-session.
• 1: multi-session.

Specifies whether to automatically complete the payment for subscription orders.

The remarks of the shared group.

The minimum number of subscription cloud computers that can be automatically provisioned at the same time in the shared group. This parameter is required if you set ChargeType to PrePaid. Default value: 1. Valid values: 0 to MaxDesktopsCount.

The maximum number of pay-as-you-go cloud computers that can be automatically provisioned at the same time in the shared group. Valid values: 0 to 500.

Specifies whether to enable batch-based automatic creation of subscription cloud computers for the shared group. This parameter is required if you set ChargeType to PrePaid.

Valid values:

• 0: enables batch-based automatic creation of subscription cloud computers.
• 1: disables batch-based automatic creation of subscription cloud computers.

The maximum number of pay-as-you-go cloud computers that can be reserved in the shared group. This parameter is required if you set ChargeType to PostPaid. Valid values:

• 0: does not reserve any cloud computers.
• N: reserves N cloud computers (1≤ N ≤ 100).

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

The IDs of the end users.

The reset option of the shared group.

Valid values:

• 0: Reset is not required.
• 1: Only the system disk is reset.
• 2: Only the data disk is reset.
• 3: Both the system disk and the data disk are reset.

The load balancing policy of the multi-session shared group.

Valid values:

• 0: depth-first
• 1: breadth first

The number of concurrent sessions of the multi-session shared group.

The type of the cloud computers in the shared group.

Valid values:

• teacher: cloud computers designed for teachers.
• student: cloud computers designed for students.

The types of the users.

Specifies whether to enable disk encryption.

The ID of the Key Management Service (KMS) key that you want to use when disk encryption is enabled. You can call the ListKeys operation to obtain a list of KMS keys.

The threshold for the ratio of connected sessions. This parameter defines the condition that activates automatic scaling of cloud computers in a multi-session shared group. The ratio of connected sessions is calculated by using the following formula:

Ratio of connected sessions = Number of connected sessions/(Total number of cloud computers × Maximum number of sessions allowed for each cloud computer) × 100%.

If the connected session ratio exceeds the specified threshold, new cloud computers are provisioned. If the ratio falls below the threshold, idle cloud computers are deleted.

The maximum duration for which each session remains connected. The session is automatically disconnected once the specified maximum time limit is reached. Unit: milliseconds. Valid values: 900000 to 345600000. That is, the session can be connected for 15 to 5,760 minutes (4 days).

The duration after which a session is terminated if no keyboard or mouse activity is detected. When an end user connects to a cloud computer, a session is initiated. If no input from the keyboard or mouse is detected within this specified timeframe, the session is automatically closed. Unit: milliseconds. Valid values: 360000 to 3600000 (6 minutes to 60 minutes)

The system prompts end users to save their data 30 seconds before a session is disconnected. To avoid data loss, end users must save their session data upon receiving the prompt.

The maximum period of inactivity allowed before a cloud computer is automatically stopped. If the idle duration reaches the specified limit, the system stops the cloud computer. When an end user reconnects to the stopped cloud computer, it automatically restarts. Unit: milliseconds.

Specifies whether to enable user data roaming.

The ID of the File Storage NAS (NAS) file system for the user data roaming feature.

• For shared subscription groups, this parameter defines the initial number of cloud computers to be created. Valid values: 0 to 200.
• For shared pay-as-you-go groups, this parameter defines the minimum initial number of cloud computers to be created. Valid values: 0 to MaxDesktopsCount. Default value: 1.

The version of the shared group.

Specifies whether to enable auto-renewal for the shared subscription group.

Valid values:

• true
• false

The tags. You can specify up to 20 tags.

The ID of the coupon.

The ID of the image.

The category of the system disk.

Valid values:

• cloud_auto: the standard SSD.
• cloud_essd: the Enterprise SSD (ESSD).

The size of the system disk. Unit: GiB.

The performance level (PL) of the system disk of the ESSD category. Default value: PL0.

Valid values:

• PL1
• PL0

The category of the data disk.

Valid values:

• cloud_auto: the standard SSD.
• cloud_essd: the ESSD.

The size of the data disk. Unit: GB. Valid values: 0 to 16380. The value must be an integral multiple of 20.

• A value of 0 means no data disk is attached.
• If the selected plan includes a standard SSD, the data disk size must be at least 20 GB.

Default value: 0.

The PL of the data disk of the ESSD category. Default value: PL0.

Valid values:

• PL1
• PL0

The language of the OS.

Valid values:

• en-US: English.
• zh-HK: Traditional Chinese.
• zh-CN: Simplified Chinese
• ja-JP: Japanese.

The specifications of the cloud computer. You can call the DescribeDesktopTypes operation to query all the supported specifications.

The hostname series of the cloud computer. This parameter is supported exclusively when the office network operates on Active Directory (AD) and the cloud computer runs on a Windows operating system.

Naming conventions:

• A hostname must be 2 to 15 characters in length
• and can contain only letters, digits, and hyphens (-). It cannot start or end with a hyphen (-), contain consecutive hyphens (-), or contain only digits.

If you want to create multiple cloud computers, specify their hostnames in the name_prefix[begin_number,bits]name_suffix format. For example, if you set Hostname to ecd-[1,4]-test, the hostnames of the cloud computers will be assigned sequentially as ecd-0001-test, ecd-0002-test, and so on.

• name_prefix: the prefix of the hostname.
• [begin_number,bits]: the sequential number in the hostname. The begin_number value is the starting number. Valid values of begin_number: 0 to 999999. Default value: 0. The bits value is the number of digits. Valid values: 1 to 6. Default value: 6.
• name_suffix: the suffix of the hostname.

Specifies whether the shared group is a multi-cloud computer type.

Valid values:

• true: a multi-cloud computer type.
• false: a single-cloud computer type.

Specifies whether the shared group is exclusive. You must set this parameter to Exclusive when SessionType is set to MultipleSession.

The number of shared groups for the single-cloud computer type. You must specify this parameter if you set MultiResource to false. Valid values: 1 to 5. Default value: 1.

The type of the session.

Valid values:

• SingleSession
• MultipleSession

The ID of the timer group.

The ID of the automatic snapshot policy.