Delivery Groups Overview for App Streaming - App Streaming - Alibaba Cloud - App Streaming

Queries the details of multiple delivery groups. This operation does not specify a particular delivery group but queries the details of all delivery groups that meet the specified conditions.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of query results per page. Maximum value: `100`.	10
PageNumber	integer	No	The page number of the query results to display.	1
Status	array	No	The list of delivery group statuses.
	string	No	The delivery group status. Valid values: PUBLISHED : 发布成功 FAILED : 发布失败 MAINTAIN_FAILED : 更新失败 EXPIRED : 已到期 MAINTAINING : 更新中 CEASED : 已欠费 EXPIRED_RECYCLING : 过期回收中 DEPLOYING : 发布中	"Status.1":"PUBLISHED","Status.2":"FAILED"
AppInstanceGroupId	string	No	The delivery group ID.	aig-9ciijz60n4xsv****
ProductType	string	Yes	The product type. Valid values: CloudApp : WUYING Cloud Application.	CloudApp
AppInstanceGroupName	string	No	The delivery group name. Fuzzy match is used for the query. For example, if you set the delivery group name to `Office App`, all delivery groups whose names contain `Office App` are returned, such as `My Office App` and `Office App A`.	办公应用
AppCenterImageId	string	No	The application image ID. You can obtain this value from the Image Management page in the WUYING Cloud Application console.	img-8z4nztpaqvay4****
RegionId `deprecated`	string	No	The region ID.	cn-hangzhou
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
NodeInstanceType	string	No	The specification type ID of the purchased resources. You can call the ListNodeInstanceType operation to obtain this value.	appstreaming.vgpu.4c8g.2g
OfficeSiteId	string	No	The office network ID.	cn-hongkong+dir-643067****
Tag	array<object>	No	The tags.
	object	No	The tag.
Key	string	No	The tag key.	department
Value	string	No	The tag value.	design
UserGroupIds	array	No
	string	No
ExcludedUserGroupIds	array	No
	string	No

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TotalCount	integer	The total number of query results.	15
PageSize	integer	The number of query results per page.	10
PageNumber	integer	The page number of the query results currently displayed.	1
AppInstanceGroupModels	array<object>	The delivery group information.
	array<object>	The delivery group information.
Apps	array<object>	The application information.
	object	The application information.
AppId	string	The app ID.	ca-i87mycyn419nu****
AppName	string	The app name.	办公应用
AppVersion	string	The app version.	1.0.0
AppVersionName	string	The name of the app version.	初始版本
AppIcon	string	The app 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. Valid values: CloudApp : WUYING Cloud Application.	CloudApp
AppInstanceType	string	The specification type of the delivery group.	__dynamic__
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 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 duration of no session connections, in minutes. When a resource remains in a no-session-connection state 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
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 : Expired and being recycled. DEPLOYING : Publishing.	PUBLISHED
NodePool	array<object>	The resource group information.
	array<object>	The resource group object.
NodePoolId	string	The ID of the resource group.	rg-g6922kced36hx****
NodeInstanceType	string	The ID of the resource specification 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 that can be connected to a resource 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 specification. 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	The maximum number of idle sessions. After you specify a value for this parameter, auto scale-out is triggered only if the number of idle sessions in the delivery group is smaller than the specified value and the session usage exceeds the value specified for `ScalingUsageThreshold`. Otherwise, the system determines that idle sessions in the delivery group are sufficient and does not perform auto scale-out.`` You can use this parameter to flexibly manage auto scaling and reduce costs.	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 scale-out is 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, auto scale-in is triggered. Default value: 5.	5
RecurrenceSchedules	array<object>	The intervals at which the scaling policy is executed.
	array<object>	The interval at which the scaling policy is executed.
RecurrenceType	string	The schedule type of the scaling policy. This parameter must be configured together with `RecurrenceValues`.`` Valid value: weekly: The scaling policy is executed on specific days each week. Valid values: weekly :	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. Valid values: 1: Monday 2: Tuesday 3: Wednesday 4: Thursday 5: Friday 6: Saturday 7: Sunday Valid values: 1 : 2 : 3 : 4 : 5 : 6 : 7 :	1
TimerPeriods	array<object>	The time periods during which the scaling policy can be executed.
	object	The time period during which the scaling policy can be executed.
Amount	integer	The number of destination resources.	5
EndTime	string	The time when the scaling policy ends. Format: HH:mm.	11:00
StartTime	string	The time when the scaling policy starts. 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 resource prefetch is enabled.	false
NodeTypeName	string	The name of the resource specification.	无影-通用型_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 over-the-air update 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. Valid values: Windows : Windows	Windows
ResourceStatus	string	The resource status. Valid values: AVAILABLE : Available. RELEASED : Released. EXPIRED_IN_7_DAYS : Expiring within 7 days. UNAVAILABLE : Unavailable. UPGRADING : Updating. CREATING : Being created.	AVAILABLE
AppPolicyId	string	The policy ID.	pg-g3k5wa2ms2****
ChargeResourceMode	string	The sales mode. Valid values: AppInstance : Sold by session. Node : Sold by resource.	Node
SkipUserAuthCheck	boolean	Indicates whether user authorization verification is skipped. Valid values: true : Verification is skipped. false : Verification is performed. [Default].	false
OfficeSiteId	string	The office network ID.	cn-beijing+dir-172301****
AppPolicyVersion	string	The policy version. Valid values: CENTER : Unified policy [new policy]. DEFAULT : Default policy [legacy policy].	CENTER
AppPolicyImageCheck	boolean	Indicates whether the current image supports the unified policy. Valid values: true : Supported. false : Not supported.	false
ResourceTags	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 System Valid values: Custom : 自定义标签 System : 系统标签	Custom
Tags	array<object>	The list of resource tags.
	object	The resource tag.
Key	string	Tag key.	department
Value	string	Tag value.	design
Scope	string	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****",
  "TotalCount": 15,
  "PageSize": 10,
  "PageNumber": 1,
  "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__",
      "AppInstanceGroupId": "aig-9ciijz60n4xsv****",
      "Amount": 1,
      "MinAmount": 1,
      "MaxAmount": 10,
      "ReserveAmountRatio": "20",
      "ReserveMinAmount": 1,
      "ReserveMaxAmount": 5,
      "ScalingStep": 10,
      "ScalingUsageThreshold": "85",
      "ScalingDownAfterIdleMinutes": 5,
      "ChargeType": "PrePaid",
      "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",
      "ResourceStatus": "AVAILABLE",
      "AppPolicyId": "pg-g3k5wa2ms2****",
      "ChargeResourceMode": "Node",
      "SkipUserAuthCheck": false,
      "OfficeSiteId": "cn-beijing+dir-172301****\n",
      "AppPolicyVersion": "CENTER",
      "AppPolicyImageCheck": false,
      "ResourceTags": [
        {
          "Key": "department",
          "Value": "design",
          "Scope": "Custom"
        }
      ],
      "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.