DocsICP FilingConsole
官方文档
首页

SetDesktopGroupScaleTimer

更新时间：
复制 MD 格式
产品详情
我的收藏

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.

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

update

*All Resource

*

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

  • drop

  • normal

  • peak

  • rise

Valid values:

  • drop :
  • normal :
  • peak :
  • rise :

rise
RatioThreshold

number

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:

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

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.85
KeepDuration

integer

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.

180000
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: depth-first

  • 1: breadth first.

Valid values:

  • 0 :
  • 1 :

0

Response elements

Element

Type

Description

Example

object

Schema of response.

RequestId

string

The ID of the request.

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.