All Products
Search

This Product

    App Streaming:GetAppInstanceGroup

    Document Center

    App Streaming:GetAppInstanceGroup

    Last Updated:Jul 21, 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 application version name.

    初始版本
    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 is the ratio of unused sessions in the delivery group. Valid values: 0 to 99.

    20
    ReserveMinAmount

    integer

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

    1
    ReserveMaxAmount

    integer

    The maximum number of reserved instances, which is 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 operation. 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 formula for session usage is: 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 successfully.

    • 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 resource group ID.

    rg-g6922kced36hx****
    NodeInstanceType

    string

    The instance type ID of the purchased resource.

    appstreaming.vgpu.4c8g.2g
    NodeAmount

    integer

    The total number of current subscription resources.

    1
    NodeUsed

    integer

    The resource count of subscription resources in use.

    1
    NodeCapacity

    integer

    The number of concurrent sessions, which is the number of sessions that a single resource can handle simultaneously. If too many sessions are connected simultaneously, the application experience may degrade. The valid values vary by resource specification:

    • 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 elastic resources.

    8
    ScalingNodeUsed

    integer

    The resource count of elastic resources in use.

    4
    StrategyType

    string

    The elastic policy type.

    Note

    NODE_SCALING_BY_USAGE (usage-based scaling policy) applies only to PrePaid (subscription) resources. NODE_SCALING_BY_SCHEDULE (scheduled scaling policy) applies only to PostPaid (pay-as-you-go) resources.

    Valid values:

    • NODE_FIXED :

      No elastic resources used.

    • NODE_SCALING_BY_SCHEDULE :

      Scheduled scaling.

    • NODE_SCALING_BY_USAGE :

      Usage-based scaling policy.

    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 during scale-out.

    8
    MaxIdleAppInstanceAmount

    integer

    The upper limit 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 delivery group is less than MaxIdleAppInstanceAmount. Otherwise, the delivery group is considered to have sufficient idle sessions and no automatic scale-out is performed. This parameter allows you to flexibly control elastic scaling behavior and reduce costs.

    3
    ScalingStep

    integer

    The number of resources created during each scale-out event. Valid values: 1 to 10.

    2
    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 current sessions ÷ (Total number of resources × Concurrent sessions per resource) × 100%.

    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. Default value: 5.

    5
    RecurrenceSchedules

    array<object>

    The list of policy execution cycles.

    array<object>

    The policy execution cycle.

    RecurrenceType

    string

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

    Weekly
    RecurrenceValues

    array

    The list of values for the policy execution cycle.

    integer

    The value of the policy execution cycle.

    1
    TimerPeriods

    array<object>

    The list of time periods for the policy execution cycle.

    object

    The time period for the policy execution cycle.

    Amount

    integer

    The target resource count.

    5
    EndTime

    string

    The end time. Format: HH:mm.

    11:00
    StartTime

    string

    The start time. Format: HH:mm.

    09:30
    StrategyDisableDate

    string

    The date when the policy expires. Format: yyyy-MM-dd.

    2022-09-08
    StrategyEnableDate

    string

    The date when the policy takes effect. Format: yyyy-MM-dd.

    2022-08-01
    WarmUp

    boolean

    Indicates whether the resource prefetch policy is enabled.

    false
    NodeTypeName

    string

    The resource specification name.

    无影-通用型_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 a session is disconnected from the end user, 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.

    OfficeApp.
    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. An empty value indicates that no new version is available.

    0.0.1-D-20220630.11****
    TaskId

    string

    The OTA upgrade task ID.

    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

    Specifies whether to skip user authorization verification.

    Valid values:

    • true :

      No verification.

    • false :

      Verification. [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

    The tag key.

    department
    Value

    string

    The tag value.

    design
    Scope

    string

    The tag type.

    Valid values:

    • Custom :

      Custom tag.

    • System :

      System tag.

    Custom
    AuthMode

    string

    The authorization mode.

    Valid values:

    • App :

      Application authorization.

    • AppInstanceGroup :

      Delivery group authorization.

    • Session :

      Session 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.