All Products
Search

This Product

    App Streaming:CreateAppInstanceGroup

    Document Center

    App Streaming:CreateAppInstanceGroup

    Last Updated:Jun 17, 2026

    Creates a delivery group.

    Operation description

    Make sure that you are familiar with the billing and pricing of WUYING Cloud Application before you call this operation.

    A delivery group is a logical grouping for delivering cloud applications to end users. It includes the underlying cloud application resources, images that contain cloud applications, resource management policies, and user assignment settings. For details, see Publish a delivery group.

    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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    AppCenterImageId

    string

    Yes

    The application image ID. You can obtain the ID from the O&M > Custom Images or System Images page in the WUYING Cloud Application console.

    img-8z4nztpaqvay4****
    ProductType

    string

    Yes

    The product type.

    Valid values:

    • CloudApp :

      WUYING Cloud Application.

    CloudApp
    AppInstanceGroupName

    string

    No

    The name of the delivery group.

    办公应用
    Users

    array

    No

    The list of usernames to be added to the delivery group as assigned users.

    string

    No

    The username to be added to the delivery group as an assigned user. Format: Users.N=<username>, where N is a positive integer.

    Users.1=username1 Users.2=username2
    UserInfo

    object

    No

    The user information of the users to be added to the delivery group. This field is required if the Users parameter is specified.

    Type

    string

    No

    The user account type.

    Valid values:

    • Simple :

      Convenience account.

    Simple
    ChargeType

    string

    Yes

    The billing method.

    Valid values:

    • PostPaid :

      Pay-as-you-go.

    • PrePaid :

      Subscription.

    PrePaid
    PromotionId

    string

    No

    The promotion ID. You can call the GetResourcePrice operation to obtain the ID.

    17440009****
    AutoPay

    boolean

    No

    Specifies whether to enable automatic payment.

    Valid values:

    • true :

      Automatic payment is enabled.

    • false :

      Manual payment is required. [Default value].

    false
    AutoRenew

    boolean

    No

    Specifies whether to enable auto-renewal.

    Valid values:

    • true :

      Auto-renewal is enabled.

    • false :

      Manual renewal is required. [Default value].

    false
    Period

    integer

    Yes

    The subscription duration of the resource when ChargeType is set to PrePaid. This parameter is required. The unit is specified by PeriodUnit.

    • If PeriodUnit is set to Week, valid values:

      • 1

    • If PeriodUnit is set to Month, valid values:

      • 1

      • 2

      • 3

      • 6

    • If PeriodUnit is set to Year, valid values:

      • 1

      • 2

      • 3

    Note

    If ChargeType is set to PostPaid, set this parameter to 1.

    1
    PeriodUnit

    string

    Yes

    The unit of the subscription duration when ChargeType is set to PrePaid.

    Note

    This parameter is case-sensitive. For example, Week is valid, but week is invalid. If the request parameters do not match the valid combinations, such as 2 Week, the API call succeeds but an error occurs during the order placement.

    Note

    If ChargeType is set to PostPaid, set this parameter to Month.

    Valid values:

    • Month :

      month.

    • Year :

      year.

    • Week :

      week.

    Week
    SessionTimeout

    integer

    Yes

    The application recycling timeout period, in minutes. After an end user disconnects from a cloud application for a period of time, the cloud application process exits. This period is the application recycling timeout. Set this parameter to -1 if you do not want the application to be recycled. Valid values: -1 and 3 to 300 (integer). Default value: 15.

    15
    BizRegionId

    string

    Yes

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

    Valid values:

    • cn-shanghai :

      China (Shanghai).

    • cn-hangzhou :

      China (Hangzhou).

    cn-hangzhou
    ChargeResourceMode

    string

    Yes

    The sales mode.

    Valid values:

    • Node :

      Sold by resource.

    Node
    NodePool

    object

    No

    The node pool object.

    NodeInstanceType

    string

    No

    The instance type ID of the resource to purchase. You can call the ListNodeInstanceType operation to obtain the ID.

    Valid values:

    • appstreaming.vgpu.8c16g.4g :

      无影-图形型_8 核 16G 4G 显存

    • appstreaming.general.8c16g :

      无影-通用型_8 核 16G

    • appstreaming.general.4c8g :

      无影-通用型_4 核 8G

    • appstreaming.vgpu.14c93g.12g :

      无影-图形型_14 核 93G 12G 显存

    • appstreaming.vgpu.8c31g.16g :

      无影-图形型_8 核 31G 16G 显存

    appstreaming.general.4c8g
    NodeAmount

    integer

    No

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

    Note

    • This parameter is required for subscription resources.

    • This parameter is required for pay-as-you-go resources when the scaling mode (StrategyType) is set to fixed quantity (NODE_FIXED) or auto scaling (NODE_SCALING_BY_USAGE).

    1
    NodeCapacity

    integer

    No

    The number of concurrent sessions, which is the number of sessions that a single resource can handle simultaneously. Too many concurrent sessions may degrade the application experience. The valid value range varies by resource specification. You can call the ListNodeInstanceType operation to obtain the valid value range for each resource specification.

    2
    StrategyType

    string

    No

    The scaling mode.

    Note

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

    • NODE_SCALING_BY_USAGE (auto 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 :

      Auto scaling.

    NODE_FIXED
    MaxScalingAmount

    integer

    No

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

    10
    MaxIdleAppInstanceAmount

    integer

    No

    The maximum number of idle sessions. When this value is specified, auto 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 are considered sufficient and no auto scale-out is performed. This parameter allows you to flexibly control elastic scaling behavior and reduce costs.

    3
    ScalingStep

    integer

    No

    The number of resources to create per scale-out operation. Valid values: 1 to 10. This field is required when StrategyType is set to NODE_SCALING_BY_USAGE (elastic resources).

    2
    ScalingUsageThreshold

    string

    No

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

    85
    ScalingDownAfterIdleMinutes

    integer

    No

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

    • If releasing the resource would trigger auto scale-out again, the scale-down is not performed to avoid repeated scaling operations.

    • If auto scale-out is triggered due to increased sessions during this period, the resource is not released 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 field is required when StrategyType (scaling mode) is set to NODE_SCALING_BY_SCHEDULE (scheduled scaling).

    2022-08-01
    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 field is required when StrategyType (scaling mode) is set to NODE_SCALING_BY_SCHEDULE (scheduled scaling).

    2022-09-08
    WarmUp

    boolean

    No

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

    false
    RecurrenceSchedules

    array<object>

    No

    The list of recurrence schedules. This field is required when StrategyType (scaling mode) is set to NODE_SCALING_BY_SCHEDULE (scheduled scaling).

    array<object>

    No

    The recurrence schedule.

    RecurrenceType

    string

    No

    The type of the recurrence schedule. You must specify both RecurrenceType and RecurrenceValues.

    Valid values:

    • weekly :

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

    weekly
    RecurrenceValues

    array

    No

    The list of recurrence values.

    integer

    No

    The recurrence value.

    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 recurrence schedule. Requirements for time period settings:

    • You can add up to 3 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 for the recurrence schedule.

    StartTime

    string

    No

    The start time of the time period. Format: HH:mm.

    12:00
    EndTime

    string

    No

    The end time of the time period. Format: HH:mm.

    15:00
    Amount

    integer

    No

    The number of resources.

    2
    Network

    object

    No

    The network configuration.

    Note

    To use this parameter, submit a ticket.

    StrategyType

    string

    No

    The network policy type.

    Valid values:

    • Mixed :

      Mixed mode: single VPC, dual NICs with dedicated public IP addresses.

    • Shared :

      Shared mode: single NIC, public network access through NAT gateway.

    Shared
    Routes

    array<object>

    No

    The route configurations. This parameter can be configured only when the network policy type (StrategyType) is set to mixed mode (Mixed).

    object

    No

    The route configuration.

    Destination

    string

    No

    The access destination. CIDR format.

    139.196.XX.XX/32
    Mode

    string

    No

    The network egress mode.

    Valid values:

    • Shared :

      Access through NAT gateway.

    Shared
    IpExpireMinutes

    integer

    No

    The duration (in minutes) after which the public IP address is refreshed upon the next logon. Minimum value: 60.

    60
    OfficeSiteId

    string

    No

    The office network ID.

    cn-hongkong+dir-842567****
    VSwitchIds

    array

    No

    The list of vSwitch IDs.

    • Valid only for custom office networks.

    string

    No

    The vSwitch ID.

    vsw-m5ef1sjhf7bbvqvvy****
    DomainRules

    array<object>

    No

    The domain name rule configurations.

    object

    No

    The domain name rule.

    Domain

    string

    No

    The domain name.

    www.example.com
    Policy

    string

    No

    The policy value.

    Valid values:

    • allow :

      Allow access.

    • block :

      Block access.

    block
    StoragePolicy

    object

    No

    The storage policy.

    StorageTypeList

    array

    No

    The list of storage types.

    string

    No

    The storage type.

    Valid values:

    • OFF :

      Disabled.

    • PDS :

      Drive and Photo Service.

    PDS
    UserProfile

    object

    No

    The user data roaming configuration.

    UserProfileSwitch

    boolean

    No

    Specifies whether to enable user data roaming.

    Valid values:

    • false :

      Disabled.

    • true :

      Enabled.

    false
    RemoteStorageType

    string

    No

    The remote storage type used for user data roaming.

    Valid values:

    • NAS :

      NAS

    NAS
    RemoteStoragePath

    string

    No

    The remote storage path for user data roaming.

    • If not specified, the default value is the delivery group ID.

    • For cross-delivery-group (same VPC) user data roaming, set the same value for all delivery groups involved.

    ID20250101
    PreOpenAppId

    string

    No

    The pre-opened application ID.

    cag-b2ronxxd****
    VideoPolicy

    object

    No

    The display policy.

    FrameRate

    integer

    No

    The frame rate (FPS).

    Valid values:

    • 30 :

      30 FPS

    • 60 :

      60 FPS

    60
    TerminalResolutionAdaptive

    boolean

    No

    Specifies whether to use adaptive resolution.

    • true: The session resolution follows the terminal display area. In this case, SessionResolutionWidth and SessionResolutionHeight specify the maximum resolution values.

    • false: The session resolution does not follow the terminal display area. In this case, the resolution is fixed to the values of SessionResolutionWidth and SessionResolutionHeight.

    Valid values:

    • true :

      true

    • false :

      false

    false
    SessionResolutionWidth

    integer

    No

    The width of the resolution, in pixels.

    1920
    SessionResolutionHeight

    integer

    No

    The height of the resolution, in pixels.

    1080
    StreamingMode

    string

    No

    The streaming mode. Used together with the Webrtc parameter to specify the protocol type.

    • Webrtc=true and StreamingMode=video: WebRTC streaming.

    • Webrtc=false and StreamingMode=video: video streaming.

    • Webrtc=false and StreamingMode=mix: mixed streaming.

    Valid values:

    • video :

      Video streaming.

    • mix :

      Mixed streaming.

    video
    Webrtc

    boolean

    No

    Specifies whether to enable WebRTC. Used together with the StreamingMode parameter to specify the protocol type.

    • Webrtc=true and StreamingMode=video: WebRTC streaming.

    • Webrtc=false and StreamingMode=video: video streaming.

    • Webrtc=false and StreamingMode=mix: mixed streaming.

    Valid values:

    • true :

      true

    • false :

      false

    true
    RuntimePolicy

    object

    No

    The runtime policy.

    SessionType

    string

    No

    The session type.

    Valid values:

    • CONSOLE :

      Console session.

    • NORMAL :

      RDP session.

    NORMAL
    DebugMode

    string

    No

    Specifies whether to enable debug mode. To call GetDebugAppInstance and CreateImageFromAppInstanceGroup, set this field to ON.

    Valid values:

    • OFF :

      Disabled.

    • ON :

      Enabled.

    OFF
    SessionUserGenerationMode

    string

    No

    The generation mode for session users.

    • wyid: The session pre-open (SessionPreOpen) must be set to false.

    Valid values:

    • wyid :

      wyid

    wyid
    SessionPreOpen

    string

    No

    Specifies whether to enable session pre-opening.

    • If not specified, the default value is true.

    Valid values:

    • true :

      Enabled.

    • false :

      Disabled.

    false
    PerSessionPerApp

    boolean

    No

    Specifies whether to allow only one application per session.

    • When enabled, opening multiple applications in the delivery group allocates a separate session for each application, consuming more sessions.

    Valid values:

    • true :

      Enabled.

    • false :

      Disabled.

    false
    PersistentAppInstanceScheduleMode

    string

    No

    The scheduling mode for persistent sessions.

    Valid values:

    • DYNAMIC :

      Dynamic scheduling. The same persistent session can be scheduled to different nodes.

    • FIX_NODE :

      Fixed-node scheduling. The same persistent session can only be scheduled to a fixed node.

    DYNAMIC
    SecurityPolicy

    object

    No

    The security policy.

    ResetAfterUnbind

    boolean

    No

    Specifies whether to reset after unbinding.

    Valid values:

    • true :

      Reset.

    • false :

      Do not reset.

    true
    SkipUserAuthCheck

    boolean

    No

    Specifies whether to skip user authorization verification.

    Valid values:

    • true :

      Skip verification.

    • false :

      Perform verification. [Default value].

    false
    UserDefinePolicy

    object

    No

    The user-defined policy.

    CustomConfig

    string

    No

    The custom policy content. The content must comply with the image version specifications. To use this parameter, submit a ticket to enable the whitelist.

    [{"target":"agent","config":{"abc":"xxx"}}]
    AppPolicyId

    string

    No

    The policy ID.

    pg-0clfzcy0adpcf****
    ClusterId

    string

    No

    The cluster ID.

    cls-d39iq73l5c0a8****
    SubPayType

    string

    No

    The billing method subtype.

    Valid values:

    • postPaid :

      Pay-as-you-go.

    • monthPackage :

      Monthly package (supported only for cloud browsers).

    • prePaid :

      Subscription.

    postPaid
    AppPackageType

    string

    No

    The package type.

    browser.package.5.250.appstreaming.general.basic
    AuthMode

    string

    No

    The authorization mode of the delivery group.

    Valid values:

    • App :

      Application authorization.

    • AppInstanceGroup :

      Delivery group authorization.

    • Session :

      Persistent session authorization.

    App
    UserGroupIds

    array

    No

    The list of authorized user group IDs.

    string

    No

    The authorized user group ID.

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID.

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

    object

    The delivery group.

    AppInstanceGroupId

    string

    The delivery group ID.

    aig-9ciijz60n4xsv****
    OrderId

    string

    The order ID.

    12345****
    NodePoolId

    string

    The resource group ID. This parameter is returned if a resource group is created at the same time.

    rg-ew7va2g1wl3vm****

    Examples

    Success response

    JSON format

    {
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "AppInstanceGroupModel": {
    "AppInstanceGroupId": "aig-9ciijz60n4xsv****",
    "OrderId": "12345****",
    "NodePoolId": "rg-ew7va2g1wl3vm****"
  }
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 StockError.NoStock The selected specification is out of stock. Please try again later or select other specifications. The selected specification is out of stock. Please try again later or select other specifications.
    500 StockError.InvalidResourceRequest Your request cannot be processed currently due to an error. Please try again later. The inventory check failed and the system is temporarily unable to process your request. Please try again later.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.