Configures an auto scaling policy for a multi-session cloud computer. Elastic Desktop Service allows multiple end users to share a cloud computer in a multi-session cloud computer pool. This helps save costs.
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:SetDesktopGroupScaleTimer | 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 pool. | dg-2i8qxpv6t1a03**** |
| ScaleTimerInfos | array<object> | No | The information about the scheduled auto scaling task. | |
| object | No | The information about the scheduled auto scaling task. | ||
| Type | string | No | The type of the auto scaling policy. Valid values:
| rise |
| RatioThreshold | float | No | The threshold for the ratio of connected sessions. This parameter is the condition that triggers auto scaling in a multi-session cloud computer pool. Formula:
When the specified threshold is reached, new cloud computers are automatically created. When the specified threshold is not reached, idle cloud computers are released. | 0.9 |
| KeepDuration | long | No | The keep-alive duration of a session after the session is disconnected. Unit: milliseconds. Valid values: 180000 (3 minutes) to 345600000 (4 days). A value of 0 indicates that the session always keeps alive. If a session is disconnected by the end user or accidentally due to a factor and the end user does not re-establish a connection with the session within the keep-alive duration, the session expires and unsaved data is deleted. If the end user successfully re-establishes a connection with the session within the keep-alive duration, the end user returns to the session and can still access the original data. | 1000 |
| BuyResAmount | integer | No | One option for the auto scaling policy. This option specifies the number of cloud computers that you want to create in the cloud computer pool. Valid values: 0 to 200. | 5 |
| MinResAmount | integer | No | One option for the auto scaling policy. This option specifies the minimum number of cloud computers that you must create in the cloud computer pool. Valid values: 0 to 200. | 5 |
| MaxResAmount | integer | No | One option for the auto scaling policy. This option specifies the maximum number of cloud computers that you can create in the cloud computer pool. Valid values: 0 to 200. | 100 |
| Cron | string | No | The cron expression of the trigger time. | 0 0 12 ? * 1 |
| LoadPolicy | integer | No | The load balancing policy for the multi-session cloud computer pool. Valid values:
| 0 |
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 |
|---|