Modifies a cloud computer share.
Operation description
Once a cloud computer share is created, the system automatically provisions cloud computers according to the auto-scaling policy and user connections, all based on the same template and security policy. You can adjust the cloud computer share's configurations, including the share name, template, and policy, for different business scenarios.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ecd:ModifyDesktopGroup | update | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID. You can call the DescribeRegions operation to query the regions supported by Elastic Desktop Service. | cn-hangzhou |
| DesktopGroupId | string | Yes | The ID of the cloud computer share. | dg-2i8qxpv6t1a03**** |
| OwnBundleId | string | No | The ID of the cloud computer template. | b-7t275tpgjueeu**** |
| PolicyGroupId | string | No | The ID of the security policy. | pg-53iyi2aar0nd6**** |
| DesktopGroupName | string | No | The name of the cloud computer share. | desktopGroupName1 |
| ScaleStrategyId | string | No | The ID of the scaling policy group. Note
This parameter is unavailable.
| s-kakowkdl**** |
| KeepDuration | long | No | The retention period of a session after it is disconnected. Unit: milliseconds. Valid values: 180000 to 345600000. That is, the session can be retained for 3 to 5,760 minutes (4 days) after it is disconnected. If you set this parameter to 0, the session is permanently retained after it is disconnected. When a session is disconnected, take note of the following situations: If an end user does not resume the session within the specified duration, the session is closed and all unsaved data is cleared. If the end user resumes the session within the specified duration, the end user can continue to access data of the session. | 1000 |
| Comments | string | No | The remarks. | test |
| MinDesktopsCount | integer | No | The maximum number of auto-created cloud computers allowed in the subscription cloud computer share. You must specify this parameter when | 1 |
| MaxDesktopsCount | integer | No | The maximum number of cloud computers allowed in the pay-as-you-go cloud computer share. Valid values: 0 to 500. | 10 |
| AllowAutoSetup | integer | No | Specifies whether to enable auto-creation of cloud computers for the subscription cloud computer share. You must specify this parameter when Valid values:
| 1 |
| AllowBufferCount | integer | No | The maximum number of standby cloud computers that can be reserved within the pay-as-you-go cloud computer share. You must specify this property only when
Note
Setting this parameter to 0 means no cloud computers will be reserved within the cloud computer share. In this case, the system must create, start, and assign cloud computers to end users upon request, which can be time-consuming. To improve user experience, we recommend that you reserve a specific number of cloud computers.
| 1 |
| ResetType | long | No | The disk reset type of cloud computers. Valid values:
| 0 |
| LoadPolicy | long | No | The load balancing policy for the multi-session many-to-many share. Note
This parameter is not publicly available.
Valid values:
| 0 |
| BindAmount | long | No | The number of concurrent sessions allowed for each cloud computer within the multi-session many-to-many share. Note
This parameter is not publicly available.
| 1 |
| ImageId | string | No | The IDs of the images. | desktopimage-windows-server-2016-64-ch |
| Classify | string | No | The type of the cloud computer share. Note
This parameter is not publicly available.
Valid values:
| teacher |
| RatioThreshold | float | No | The threshold for the ratio of connected sessions, which triggers automatic scaling of cloud computers within the multi-session many-to-many share. To calculate the ratio of connected sessions, use the following formula:
If the session ratio exceeds the threshold, new cloud computers are provisioned. If it falls below the threshold, additional cloud computers are removed. Note
This parameter is not publicly available.
| 0.5 |
| ConnectDuration | long | No | The maximum period of time during which the session is connected. When the specified maximum period of time is reached, the session is automatically disconnected. Unit: milliseconds. Valid values: 900000 to 345600000. That is, the session can be connected for 15 to 5,760 minutes (4 days). | 600000 |
| IdleDisconnectDuration | long | No | After an end user connects to a cloud computer, the session is established. If the system does not detect inputs from the keyboard or mouse within the specified period of time, the session is closed. Unit: milliseconds. Valid values: 360000 to 3600000 (6 minutes to 60 minutes) End users can receive a prompt to save data before sessions are disconnected. The system sends the prompt 30 seconds before the specified period of time is reached. To prevent data loss, end users must save the data of the sessions. Note
This parameter is suitable only for cloud computers whose image version is v1.0.2 or later.
| 120000 |
| DisableSessionConfig | boolean | No | Specifies whether to disable session management. | true |
| StopDuration | long | No | The period of time before the idle cloud computer enters the Stopped state. When the specified period of time is reached, the cloud computer is automatically stopped. If an end user connects to the stopped cloud computer, the cloud computer automatically starts. Unit: milliseconds. | 180000 |
| ProfileFollowSwitch | boolean | No | Specifies whether to enable user data roaming. Note
This parameter is unavailable.
| false |
| FileSystemId | string | No | The ID of the File Storage NAS (NAS) file system for the user data roaming feature. Note
This parameter is unavailable.
| 04f314**** |
| PolicyGroupIds | array | No | The IDs of policy groups. | |
| string | No | The ID of the policy group. | pg-gx2x1dhsmthe9**** | |
| BuyDesktopsCount | integer | No |
| 5 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|