All Products
Search

This Product

    App Streaming:ModifyNodePoolAttribute

    Document Center

    App Streaming:ModifyNodePoolAttribute

    Last Updated:Jun 17, 2026

    Modifies the scaling mode of a delivery group, including fixed quantity (no elastic scaling), scheduled scaling, and automatic scaling.

    Operation description

    You can configure the scaling pattern for WUYING Cloud Application resources in Settings:

    • Fixed quantity: Elastic scaling is not used.

    • Automatic scaling: Automatically scales resources based on the number of connected sessions and the idle duration without session connections.

    • Scheduled scaling: Executes resource scaling during specified time periods on specified dates.

    Before using this operation, make sure that you fully understand the billing method and pricing of WUYING Cloud Application.

    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

    appstreaming:ModifyNodePoolAttribute

    update

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ProductType

    string

    No

    The product type.

    Valid values:

    • CloudApp :

      WUYING Cloud Application.

    CloudApp
    PoolId

    string

    No

    The resource group ID.

    rg-ew7va2g1wl3vm****
    NodeCapacity

    integer

    No

    The number of concurrent sessions, which is the number of sessions that can be simultaneously connected to a single resource. If too many sessions are connected simultaneously, the application experience may degrade. The valid values vary depending on the resource specification. The valid values for each resource specification are as follows:

    • appstreaming.general.4c8g: 1 to 2.

    • appstreaming.general.8c16g: 1 to 4.

    • appstreaming.vgpu.8c16g.4g: 1 to 4.

    • appstreaming.vgpu.8c31g.16g: 1 to 4.

    • appstreaming.vgpu.14c93g.12g: 1 to 6.

    2
    NodePoolStrategy

    object

    No

    The automatic scaling policy of the delivery group.

    StrategyType

    string

    No

    The scaling mode.

    Note

    • NODE_FIXED (fixed quantity): Applicable to subscription and pay-as-you-go resources.

    • NODE_SCALING_BY_USAGE (automatic scaling): Applicable to subscription and pay-as-you-go resources.

    • NODE_SCALING_BY_SCHEDULE (scheduled scaling): Applicable only to pay-as-you-go resources.

    Valid values:

    • NODE_FIXED :

      Fixed quantity (no elastic scaling).

    • NODE_SCALING_BY_SCHEDULE :

      Scheduled scaling.

    • NODE_SCALING_BY_USAGE :

      Automatic scaling.

    NODE_FIXED
    NodeAmount

    integer

    No

    The number of purchased resources. Valid values: 1 to 100.

    Note

    • If the resources are subscription resources, this parameter cannot be modified.

    • If the resources are pay-as-you-go resources, this parameter can be modified when the scaling mode (StrategyType) is set to fixed quantity (NODE_FIXED) or automatic scaling (NODE_SCALING_BY_USAGE).

    1
    MaxScalingAmount

    integer

    No

    The maximum number of resources that can be created during scale-out. This parameter is required when StrategyType is set to NODE_SCALING_BY_USAGE.

    10
    MaxIdleAppInstanceAmount

    integer

    No

    The maximum number of idle sessions. When this value is specified, automatic scale-out is triggered only when the session usage exceeds ScalingUsageThreshold and the number of idle sessions in the current delivery group is less than MaxIdleAppInstanceAmount. Otherwise, the idle sessions in the delivery group are considered sufficient, and no automatic scale-out is performed. This parameter can be used to flexibly control elastic scale-out behavior and reduce costs.

    3
    ScalingStep

    integer

    No

    The number of resources created per scale-out operation. Valid values: 1 to 10. This parameter is required when StrategyType is set to NODE_SCALING_BY_USAGE.

    2
    ScalingUsageThreshold

    string

    No

    The upper threshold of session usage (%). Automatic scale-out is triggered when the session usage exceeds this threshold. The session usage is calculated by using the following formula: Session usage = Current sessions ÷ (Total resources × Concurrent sessions per resource) × 100%. This parameter is required when StrategyType is set to NODE_SCALING_BY_USAGE. Valid values: 0 to 100. Default value: 85.

    85
    ScalingDownAfterIdleMinutes

    integer

    No

    The maximum duration (in minutes) that a resource without session connections is retained. When no sessions are connected to a resource, a countdown starts based on the duration specified here. The resource is scaled in when the countdown ends. Valid values: 5 to 120. Default value: 5. The following exceptions apply:

    • If scale-in would trigger automatic scale-out again, the scale-in is not performed to avoid repeated scale-in and scale-out operations.

    • If automatic scale-out is triggered by an increase in sessions during this period, the resource is not scaled in as originally planned, and the countdown restarts.

    5
    StrategyEnableDate

    string

    No

    The date when the policy takes effect. Format: yyyy-MM-dd. The date must be equal to or later than the current date. This parameter is required when StrategyType (scaling mode) is set to NODE_SCALING_BY_SCHEDULE (scheduled scaling).

    2023-01-05
    StrategyDisableDate

    string

    No

    The date when the policy expires. Format: yyyy-MM-dd. The interval between the expiration date and the effective date must be between 7 days and 1 year, inclusive. This parameter is required when StrategyType (scaling mode) is set to NODE_SCALING_BY_SCHEDULE (scheduled scaling).

    2023-01-19
    WarmUp

    boolean

    No

    Specifies whether to enable the resource prefetch policy. This parameter is required when StrategyType (scaling mode) is set to NODE_SCALING_BY_SCHEDULE (scheduled scaling).

    false
    RecurrenceSchedules

    array<object>

    No

    The list of policy execution cycles. This parameter is required when StrategyType (scaling mode) is set to NODE_SCALING_BY_SCHEDULE (scheduled scaling).

    array<object>

    No

    The policy execution cycle.

    RecurrenceType

    string

    No

    The type of the policy execution cycle. You must specify both RecurrenceType and RecurrenceValues.

    Valid values:

    • weekly :

      weekly (the scheduled task is executed on specified days of each week).

    weekly
    RecurrenceValues

    array

    No

    The list of values for the policy execution cycle.

    integer

    No

    The value of the policy execution cycle.

    Valid values:

    • 1 :

      Monday.

    • 2 :

      Tuesday.

    • 3 :

      Wednesday.

    • 4 :

      Thursday.

    • 5 :

      Friday.

    • 6 :

      Saturday.

    • 7 :

      Sunday.

    1
    TimerPeriods

    array<object>

    No

    The list of time periods for the policy execution cycle. Requirements for time period settings:

    • You can add up to three time periods.

    • Time periods must not overlap.

    • The interval between time periods must be at least 5 minutes.

    • Each time period must be at least 15 minutes long.

    • All time periods combined must not span across days.

    object

    No

    The time period of the policy execution cycle.

    StartTime

    string

    No

    The beginning of the time period during which the scaling policy is executed. Format: HH:mm.

    12:00
    EndTime

    string

    No

    The end of the time period during which the scaling policy is executed. Format: HH:mm.

    15:00
    Amount

    integer

    No

    The number of resources.

    2
    BizRegionId

    string

    No

    The region ID of the delivery group. For more information about supported regions, see Limits.

    Valid values:

    • cn-shanghai :

      China (Shanghai).

    • cn-hangzhou :

      China (Hangzhou).

    cn-hangzhou

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

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

    string

    The error code returned if the request failed.

    InvalidParameter.PoolId
    Message

    string

    The error message returned if the request failed.

    The parameter PoolId is invalid.

    Examples

    Success response

    JSON format

    {
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "Code": "InvalidParameter.PoolId",
  "Message": "The parameter PoolId is invalid."
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.