GetAppInstanceGroup - App Streaming - Alibaba Cloud Documentation Center

Queries the details of a delivery group.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
appstreaming:GetAppInstanceGroup	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
AppInstanceGroupId	string	Yes	The ID of the delivery group. You can call the listAppInstanceGroup operation to obtain the ID.	aig-9ciijz60n4xsv****
ProductType	string	Yes	The product type. Valid value: CloudApp: App Streaming	CloudApp

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
AppInstanceGroupModels	object	AppInstanceGroupModels
Apps	array<object>	The applications.
apps	object
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 image ID of the application.	img-8z4nztpaqvay4****
RegionId	string	The ID of the region where the delivery group resides. For information about the supported regions, see Limits .	cn-hangzhou
ProductType	string	The product type.	CloudApp
AppInstanceType	string	The resource type of the delivery group.	__dynamic__
AppInstanceTypeName	string	The name of the resource type of the delivery group.	test001
AppInstanceGroupId	string	The ID of the delivery group.	aig-9ciijz60n4xsv****
Amount	integer	The number of subscription resources. 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. The value indicates the percentage of unused sessions in the delivery group. Valid values: 0 to 99.	20
ReserveMinAmount	integer	The minimum number of reserved instances. The value indicates the minimum number of unused sessions in the delivery group. Minimum value: 1.	1
ReserveMaxAmount	integer	The maximum number of reserved instances. The value indicates the maximum number of unused sessions in the delivery group. Minimum value: 1.	5
ScalingStep	integer	The number of sessions that are created each time the delivery group is scaled out. Minimum value: 1.	10
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 rate is calculated by using the following formula: Session usage rate = Number of sessions in use/Total number of sessions × 100%. Valid values: 0 to 99.	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. 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: by session Node: by resource	Node
GmtCreate	string	The time when the delivery group was created.	2022-04-26T15:06:16.000+00:00
Status	string	The status of the delivery group. Valid values: PUBLISHED: The delivery group is published. FAILED: The delivery group failed to be published. MAINTAIN_FAILED: The delivery group failed to be updated. EXPIRED: The delivery group is expired. MAINTAINING: The delivery group is being updated. CEASED: The delivery group has overdue payments. EXPIRED_RECYCLING: The delivery group is expired and being recycled. DEPLOYING: The delivery group is being published.	PUBLISHED
NodePool	array<object>	The information about the resource group.
node	object	The resource group.
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.	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.
RecurrenceSchedule	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.
RecurrenceValue	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.
TimerPeriod	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.
SpecId	string	The specification ID that uniquely corresponds to the ID of the delivery group.	spec-8o18t8uc31qib0****
SessionTimeout	string	The duration for which sessions are retained after disconnection. Unit: minutes. After an end user disconnects from a session, the session is closed only after the specified duration elapses. If you want to permanently retain sessions, set this parameter to `-1`. Valid values:-1 and 3 to 300. Default value: `15`.	15
AppInstanceGroupName	string	The name of the delivery group.
ExpiredTime	string	The time when the delivery group expires.	2022-04-27T16:00:00.000+00:00
OtaInfo	object	The information about the over-the-air (OTA) update task.
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 type of the operating system.	Windows
AppCenterImageName	string	The image name of the application.	OfficeApps
ResourceStatus	string	The resource status.	AVAILABLE
OfficeSiteId	string	办公网络 ID。	cn-beijing+dir-172301****
AppPolicyId	string	The policy ID of the application.	pg-g3k5wa2ms2****
SkipUserAuthCheck	boolean	Indicates whether user permission verification is skipped. Valid values: true false: This is the default value.	false
SessionType	string	会话类型。 Enumeration Value: CONSOLE: Console会话. NORMAL: RDP会话.	NORMAL
Tags	array<object>	资源标签列表。
Tags	object	资源标签。
Key	string	标签键。	department
Value	string	标签值。	design
Scope	string	标签类型。 Enumeration Value: Custom: 自定义标签. System: 系统标签.	Custom
AuthMode	string	授权模式。 Enumeration Value: App: 应用授权. AppInstanceGroup: 交付组授权. Session: 会话授权.	App
AccessType	string	接入类型。 Enumeration Value: INTERNET: 互联网. VPC: 企业专网（VPC）. ANY: 互联网和企业专网（VPC）.	INTERNET

Examples

Sample success responses

JSONformat

{
  "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": ""
      }
    ],
    "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"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-11-27	The response structure of the API has changed	View Change Details
2024-12-11	The response structure of the API has changed	View Change Details
2024-10-22	The response structure of the API has changed	View Change Details
2024-09-12	The response structure of the API has changed	View Change Details
2023-12-28	The response structure of the API has changed	View Change Details
2023-05-12	The response structure of the API has changed	View Change Details
2023-04-28	The response structure of the API has changed	View Change Details
2023-03-24	The response structure of the API has changed	View Change Details