All Products
Search

This Product

    App Streaming:GetAppInstanceGroup

    Document Center

    App Streaming:GetAppInstanceGroup

    Last Updated:Jun 17, 2026

    Queries the details of a specified 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

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

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    AppInstanceGroupId

    string

    Yes

    The delivery group ID. You can call the ListAppInstanceGroup operation to obtain the ID.

    aig-9ciijz60n4xsv****
    ProductType

    string

    Yes

    The product type.

    Valid values:

    • CloudApp :

      WUYING Cloud Application.

    CloudApp

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

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

    object

    AppInstanceGroupModels

    Apps

    array<object>

    The list of application information.

    object

    The application information.

    AppId

    string

    The application ID.

    ca-i87mycyn419nu****
    AppName

    string

    The application name.

    办公应用
    AppVersion

    string

    The application version.

    1.0.0
    AppVersionName

    string

    The name of the application version.

    初始版本
    AppIcon

    string

    The application icon.

    https://app-center-icon-****.png
    AppCenterImageId

    string

    The application image ID.

    img-8z4nztpaqvay4****
    RegionId

    string

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

    cn-hangzhou
    ProductType

    string

    The product type.

    CloudApp
    AppInstanceType

    string

    The instance type of the delivery group.

    __dynamic__
    AppInstanceTypeName

    string

    The name of the instance type of the delivery group.

    test001
    AppInstanceGroupId

    string

    The delivery group ID.

    aig-9ciijz60n4xsv****
    Amount

    integer

    The number of subscription resources configured by the user. Minimum value: 1.

    1
    MinAmount

    integer

    The minimum number of instances. Minimum value: 1.

    1
    MaxAmount

    integer

    The maximum number of instances. Minimum value: 1.

    10
    ReserveAmountRatio

    string

    The percentage of reserved instances, which represents the ratio of unused sessions in the delivery group. Valid values: 0 to 99.

    20
    ReserveMinAmount

    integer

    The minimum number of reserved instances, which represents the minimum number of unused sessions in the delivery group. Minimum value: 1.

    1
    ReserveMaxAmount

    integer

    The maximum number of reserved instances, which represents the maximum number of unused sessions in the delivery group. Minimum value: 1.

    5
    ScalingStep

    integer

    The number of sessions created during each scale-out event. Minimum value: 1.

    10
    ScalingUsageThreshold

    string

    The upper threshold of session usage (%). When the session usage exceeds this threshold, automatic scale-out is triggered. The session usage is calculated as follows: Session usage = Number of sessions in use ÷ Total number of sessions × 100%. Valid values: 0 to 99.

    85
    ScalingDownAfterIdleMinutes

    integer

    The idle duration without session connections, in minutes. When a resource remains without session connections for the specified duration, automatic scale-in is triggered. Minimum value: 0.

    5
    ChargeType

    string

    The billing method.

    Valid values:

    • PostPaid :

      pay-as-you-go.

    • PrePaid :

      subscription.

    PrePaid
    ChargeResourceMode

    string

    The sales mode.

    Valid values:

    • AppInstance :

      sold by session.

    • Node :

      sold by resource.

    Node
    GmtCreate

    string

    The creation time.

    2022-04-26T15:06:16.000+00:00
    Status

    string

    The delivery group status.

    Valid values:

    • PUBLISHED :

      Published.

    • FAILED :

      Publishing failed.

    • MAINTAIN_FAILED :

      Update failed.

    • EXPIRED :

      Expired.

    • MAINTAINING :

      Updating.

    • CEASED :

      Overdue.

    • EXPIRED_RECYCLING :

      Recycling after expiration.

    • DEPLOYING :

      Publishing.

    PUBLISHED
    NodePool

    array<object>

    The resource group information.

    array<object>

    The resource group information.

    NodePoolId

    string

    The ID of the resource group.

    rg-g6922kced36hx****
    NodeInstanceType

    string

    The ID of the resource type that you purchase.

    appstreaming.vgpu.4c8g.2g
    NodeAmount

    integer

    The total number of subscription resources.

    1
    NodeUsed

    integer

    The number of subscription resources that are in use.

    1
    NodeCapacity

    integer

    The maximum number of sessions to which a resource can connect at the same time. If a resource connects to a large number of sessions at the same time, user experience can be compromised. The value range varies based on the resource type. The following items describe the value ranges of different resource types:

    • 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
    ScalingNodeAmount

    integer

    The total number of scalable resources.

    8
    ScalingNodeUsed

    integer

    The number of scalable resources that are in use.

    4
    StrategyType

    string

    The type of the scaling policy.

    Note

    NODE_SCALING_BY_USAGE is returned for this parameter only if ChargeType is set to PrePaid. NODE_SCALING_BY_SCHEDULE is returned for this parameter only if ChargeType is set to PostPaid.

    Valid values:

    • NODE_FIXED: No scalable resources are used.

    • NODE_SCALING_BY_SCHEDULE: Scheduled scaling is used.

    • NODE_SCALING_BY_USAGE: Resources are scaled based on usage.

    Valid values:

    • NODE_FIXED :
    • NODE_SCALING_BY_SCHEDULE :
    • NODE_SCALING_BY_USAGE :

    NODE_FIXED
    Amount

    integer

    The number of resources purchased when the delivery group was created.

    2
    MaxScalingAmount

    integer

    The maximum number of resources that can be created for scale-out.

    8
    MaxIdleAppInstanceAmount

    integer

    空闲会话数上限。指定该值时，当会话使用率超过ScalingUsageThreshold且当前交付组空闲会话数小于MaxIdleAppInstanceAmount时，才会触发自动扩容，否则认为交付组空闲会话已足够使用，不自动扩容。该参数可用于灵活控制弹性扩容行为和降低使用成本。

    3
    ScalingStep

    integer

    The number of resources that are created each time resources are scaled out. Valid values: 1 to 10.

    2
    ScalingUsageThreshold

    string

    The upper limit of session usage. If the session usage exceeds the specified upper limit, auto scaling is automatically triggered. The session usage is calculated by using the following formula: Session usage = Number of current sessions/(Total number of resources × Number of concurrent sessions) × 100%.

    85
    ScalingDownAfterIdleMinutes

    integer

    The duration for which no session is connected. Unit: minutes. If no session is connected in the resources after the specified duration elapses, automatic scale-in is triggered. Default value: 5.

    5
    RecurrenceSchedules

    array<object>

    The schedules of the scaling policy.

    array<object>

    RecurrenceType

    string

    The schedule type of the scaling policy. This parameter must be configured together with RecurrenceValues.``

    Weekly
    RecurrenceValues

    array

    The days of each week on which the scaling policy is executed.

    integer

    The day of each week on which the scaling policy is executed.

    1
    TimerPeriods

    array<object>

    The time periods during which the scaling policy can be executed.

    object

    Amount

    integer

    The number of destination resources.

    5
    EndTime

    string

    The end time of the scaling policy. Format: HH:mm.

    11:00
    StartTime

    string

    The start time of the scaling policy. Format: HH:mm.

    09:30
    StrategyDisableDate

    string

    The expiration date of the scaling policy. Format: yyyy-MM-dd.

    2022-09-08
    StrategyEnableDate

    string

    The effective date of the scaling policy. Format: yyyy-MM-dd.

    2022-08-01
    WarmUp

    boolean

    Indicates whether the warmup policy is enabled for resources.

    false
    NodeTypeName

    string

    The name of the resource type.

    无影-通用型_4核8G
    SpecId

    string

    The ID that uniquely corresponds to the delivery group ID.

    spec-8o18t8uc31qib0****
    SessionTimeout

    string

    The session disconnection retention duration, in minutes. After an end user session is disconnected, the session is retained for the specified duration before being logged off. Set this parameter to -1 to retain the session indefinitely. Valid values: -1 and 3 to 300. Default value: 15.

    15
    AppInstanceGroupName

    string

    The delivery group name.

    办公应用
    ExpiredTime

    string

    The expiration time of the delivery group.

    2022-04-27T16:00:00.000+00:00
    OtaInfo

    object

    The OTA upgrade task information.

    OtaVersion

    string

    The current OTA version.

    0.0.1-D-20220615.11****
    NewOtaVersion

    string

    The new OTA version. A null value indicates that no new version is available.

    0.0.1-D-20220630.11****
    TaskId

    string

    The ID of the OTA update task.

    ota-e49929gv8acz5****
    OsType

    string

    The operating system type.

    Windows
    AppCenterImageName

    string

    The application image name.

    OfficeApps
    ResourceStatus

    string

    The resource status.

    AVAILABLE
    OfficeSiteId

    string

    The office network ID.

    cn-beijing+dir-172301****

    AppPolicyId

    string

    The application policy ID.

    pg-g3k5wa2ms2****
    SkipUserAuthCheck

    boolean

    Indicates whether user authorization verification is skipped.

    Valid values:

    • true :

      Verification is skipped.

    • false :

      Verification is performed. [Default value].

    false
    SessionType

    string

    The session type.

    Valid values:

    • CONSOLE :

      Console session.

    • NORMAL :

      RDP session.

    NORMAL
    Tags

    array<object>

    The list of resource tags.

    object

    The resource tag.

    Key

    string

    标签键。

    department
    Value

    string

    标签值。

    design
    Scope

    string

    标签类型。

    Valid values:

    • Custom :

      自定义标签

    • System :

      系统标签

    Custom
    AuthMode

    string

    The authorization mode.

    Valid values:

    • App :

      Application-based authorization.

    • AppInstanceGroup :

      Delivery group-based authorization.

    • Session :

      Session-based authorization.

    App
    AccessType

    string

    The access type.

    Valid values:

    • INTERNET :

      Internet.

    • VPC :

      Enterprise private network (VPC).

    • ANY :

      Internet and enterprise private network (VPC).

    INTERNET
    SupportUserGroupMixedAuth

    boolean

    UserGroupAuthMode

    string

    Mixed

    Examples

    Success response

    JSON format

    {
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "AppInstanceGroupModels": {
    "Apps": [
      {
        "AppId": "ca-i87mycyn419nu****",
        "AppName": "办公应用",
        "AppVersion": "1.0.0",
        "AppVersionName": "初始版本",
        "AppIcon": "https://app-center-icon-****.png"
      }
    ],
    "AppCenterImageId": "img-8z4nztpaqvay4****",
    "RegionId": "cn-hangzhou",
    "ProductType": "CloudApp",
    "AppInstanceType": "__dynamic__",
    "AppInstanceTypeName": "test001",
    "AppInstanceGroupId": "aig-9ciijz60n4xsv****",
    "Amount": 1,
    "MinAmount": 1,
    "MaxAmount": 10,
    "ReserveAmountRatio": "20",
    "ReserveMinAmount": 1,
    "ReserveMaxAmount": 5,
    "ScalingStep": 10,
    "ScalingUsageThreshold": "85",
    "ScalingDownAfterIdleMinutes": 5,
    "ChargeType": "PrePaid",
    "ChargeResourceMode": "Node",
    "GmtCreate": "2022-04-26T15:06:16.000+00:00",
    "Status": "PUBLISHED",
    "NodePool": [
      {
        "NodePoolId": "rg-g6922kced36hx****",
        "NodeInstanceType": "appstreaming.vgpu.4c8g.2g",
        "NodeAmount": 1,
        "NodeUsed": 1,
        "NodeCapacity": 2,
        "ScalingNodeAmount": 8,
        "ScalingNodeUsed": 4,
        "StrategyType": "NODE_FIXED",
        "Amount": 2,
        "MaxScalingAmount": 8,
        "MaxIdleAppInstanceAmount": 3,
        "ScalingStep": 2,
        "ScalingUsageThreshold": "85",
        "ScalingDownAfterIdleMinutes": 5,
        "RecurrenceSchedules": [
          {
            "RecurrenceType": "Weekly",
            "RecurrenceValues": [
              1
            ],
            "TimerPeriods": [
              {
                "Amount": 5,
                "EndTime": "11:00",
                "StartTime": "09:30"
              }
            ]
          }
        ],
        "StrategyDisableDate": "2022-09-08",
        "StrategyEnableDate": "2022-08-01",
        "WarmUp": false,
        "NodeTypeName": "无影-通用型_4核8G"
      }
    ],
    "SpecId": "spec-8o18t8uc31qib0****",
    "SessionTimeout": "15",
    "AppInstanceGroupName": "办公应用",
    "ExpiredTime": "2022-04-27T16:00:00.000+00:00",
    "OtaInfo": {
      "OtaVersion": "0.0.1-D-20220615.11****",
      "NewOtaVersion": "0.0.1-D-20220630.11****",
      "TaskId": "ota-e49929gv8acz5****"
    },
    "OsType": "Windows",
    "AppCenterImageName": "OfficeApps",
    "ResourceStatus": "AVAILABLE",
    "OfficeSiteId": "cn-beijing+dir-172301****\n",
    "AppPolicyId": "pg-g3k5wa2ms2****",
    "SkipUserAuthCheck": false,
    "SessionType": "NORMAL",
    "Tags": [
      {
        "Key": "department",
        "Value": "design",
        "Scope": "Custom"
      }
    ],
    "AuthMode": "App",
    "AccessType": "INTERNET",
    "SupportUserGroupMixedAuth": false,
    "UserGroupAuthMode": "Mixed"
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.