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

Retrieves details for multiple delivery groups. If you do not specify a delivery group, the operation returns details for all groups that match the criteria.

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 entries to return on each page. The maximum value is `100`.	10
PageNumber	integer	No	The page number.	1
Status	array	No	The statuses of the app instance groups.
	string	No	The status of the app instance group. Valid values: PUBLISHED : Published FAILED : Publishing failed MAINTAIN_FAILED : Update failed EXPIRED : Expired MAINTAINING : Updating CEASED : Suspended due to an overdue payment. EXPIRED_RECYCLING : Expired and being recycled. DEPLOYING : Publishing	"Status.1":"PUBLISHED","Status.2":"FAILED"
AppInstanceGroupId	string	No	The ID of the app instance group.	aig-9ciijz60n4xsv****
ProductType	string	Yes	The product type. Valid values: CloudApp : Wuying Cloud Application	CloudApp
AppInstanceGroupName	string	No	The name of the app instance group. This parameter supports fuzzy search. For example, if you set this parameter to `OfficeApps`, app instance groups whose names contain `OfficeApps`, such as `MyOfficeApps` and `OfficeApps A`, are returned.	办公应用
AppCenterImageId	string	No	The ID of the app image. You can obtain the image ID on 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 app instance 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 instance type. You can call the ListNodeInstanceType operation to obtain the instance types.	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 data returned.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TotalCount	integer	The total number of entries.	15
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
AppInstanceGroupModels	array<object>	Details of the app instance groups.
	array<object>	Details of the app instance group.
Apps	array<object>	The applications in the app instance group.
	object	Details of the application.
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 ID of the application image.	img-8z4nztpaqvay4****
RegionId	string	The ID of the region where the app instance group is located. For more information about the supported regions, see Limits.	cn-hangzhou
ProductType	string	The type of the product. Valid values: CloudApp : Wuying Cloud Application	CloudApp
AppInstanceType	string	The instance type of the app instance group.	__dynamic__
AppInstanceGroupId	string	The ID of the app instance group.	aig-9ciijz60n4xsv****
Amount	integer	The number of provisioned subscription resources.	1
MinAmount	integer	The minimum number of instances.	1
MaxAmount	integer	The maximum number of instances.	10
ReserveAmountRatio	string	The percentage of idle sessions to keep in reserve. Valid values: 0 to 99.	20
ReserveMinAmount	integer	The minimum number of idle sessions to keep in reserve.	1
ReserveMaxAmount	integer	The maximum number of idle sessions to keep in reserve.	5
ScalingStep	integer	The number of sessions created in each scale-out event.	10
ScalingUsageThreshold	string	The session usage threshold that triggers an auto scale-out, as a percentage. An auto scale-out is triggered when the session usage exceeds this threshold. Session usage is calculated by using the following formula: `(Number of active sessions / Total number of sessions) × 100%`. Valid values: 0 to 99.	85
ScalingDownAfterIdleMinutes	integer	The time in minutes that a resource can remain idle (with no session connections) before a scale-in is triggered. The minimum value is 0.	5
ChargeType	string	The billing method. Valid values: PostPaid : pay-as-you-go PrePaid : subscription	PrePaid
GmtCreate	string	The time when the app instance group was created.	2022-04-26T15:06:16.000+00:00
Status	string	The status of the app instance group. Valid values: PUBLISHED : Published. FAILED : Publishing failed. MAINTAIN_FAILED : Update failed. EXPIRED : Expired. MAINTAINING : Updating. CEASED : Suspended due to an overdue payment. EXPIRED_RECYCLING : Expired and being recycled. DEPLOYING : Publishing.	PUBLISHED
NodePool	array<object>	The node pools in the app instance group.
	array<object>	Details of a node pool.
NodePoolId	string	The ID of the node pool.	rg-g6922kced36hx****
NodeInstanceType	string	The instance type of the nodes in the pool.	appstreaming.vgpu.4c8g.2g
NodeAmount	integer	The total number of subscription resources in the node pool.	1
NodeUsed	integer	The number of in-use subscription resources in the node pool.	1
NodeCapacity	integer	The number of concurrent sessions that a single resource can host. A high value may degrade the user experience, and the valid values vary based on the resource specification.	2
ScalingNodeAmount	integer	The total number of pay-as-you-go resources.	8
ScalingNodeUsed	integer	The number of in-use pay-as-you-go resources.	4
StrategyType	string	The type of the scaling policy. Note The usage-based scaling policy (`NODE_SCALING_BY_USAGE`) applies only to subscription resources. The scheduled scaling policy (`NODE_SCALING_BY_SCHEDULE`) applies only to pay-as-you-go resources. Valid values: NODE_FIXED : No elastic resources are used. NODE_SCALING_BY_SCHEDULE : Scheduled scaling NODE_SCALING_BY_USAGE : Usage-based scaling	NODE_FIXED
Amount	integer	The number of resources purchased when the app instance group was created.	2
MaxScalingAmount	integer	The maximum number of resources that can be created in a single scale-out event.	8
MaxIdleAppInstanceAmount	integer	The maximum number of idle sessions to maintain. If specified, a scale-out is triggered only when the session usage exceeds `ScalingUsageThreshold` and the number of idle sessions is less than `MaxIdleAppInstanceAmount`. This parameter helps you control scaling behavior and reduce costs.	3
ScalingStep	integer	The number of resources to create in each scale-out event. Valid values: 1 to 10.	2
ScalingUsageThreshold	string	The session usage percentage that triggers an automatic scale-out. A scale-out occurs if the usage, calculated by using the formula `Session usage = (Current number of sessions / (Total number of resources × Number of concurrent sessions per resource)) × 100%`, exceeds this value.	85
ScalingDownAfterIdleMinutes	integer	The time in minutes that a resource can be idle before an automatic scale-in is triggered. Default value: 5.	5
RecurrenceSchedules	array<object>	The schedules for the scaling policy.
	array<object>	A schedule for the scaling policy.
RecurrenceType	string	The recurrence type for the scheduled task. You must specify both `RecurrenceType` and `RecurrenceValues`. Valid values: weekly : The scheduled task is repeated on specific days of the week.	Weekly
RecurrenceValues	array	The values for the recurrence schedule.
	integer	The value for the recurrence schedule. Valid values: 1 : Monday 2 : Tuesday 3 : Wednesday 4 : Thursday 5 : Friday 6 : Saturday 7 : Sunday	1
TimerPeriods	array<object>	The time periods during which the policy is in effect.
	object	A time period.
Amount	integer	The target number of resources.	5
EndTime	string	The end time, in HH:mm format.	11:00
StartTime	string	The start time, in HH:mm format.	09:30
StrategyDisableDate	string	The date on which the policy becomes ineffective. The date is in yyyy-MM-dd format.	2022-09-08
StrategyEnableDate	string	The date on which the policy takes effect. The date is in yyyy-MM-dd format.	2022-08-01
WarmUp	boolean	Indicates whether the resource warm-up policy is enabled.	false
NodeTypeName	string	The name of the resource specification.	无影-通用型_4核8G
SpecId	string	The unique ID that maps one-to-one to the app instance group ID.	spec-8o18t8uc31qib0****
SessionTimeout	string	The time in minutes to keep a session alive after a user disconnects. After this time elapses, the session is terminated. To keep the session alive indefinitely, set this value to `-1`. Valid values: -1 or 3 to 300. Default: `15`.	15
AppInstanceGroupName	string	The name of the app instance group.	办公应用
ExpiredTime	string	The time when the app instance group expires.	2022-04-27T16:00:00.000+00:00
OtaInfo	object	Details of the OTA update task.
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 ID of the OTA update task.	ota-e49929gv8acz5****
OsType	string	The operating system. Valid values: Windows : Windows	Windows
ResourceStatus	string	The resource status. Valid values: AVAILABLE : Available RELEASED : Released EXPIRED_IN_7_DAYS : Expires within 7 days UNAVAILABLE : Unavailable UPGRADING : Updating CREATING : Creating	AVAILABLE
AppPolicyId	string	The policy ID.	pg-g3k5wa2ms2****
ChargeResourceMode	string	The resource billing model. Valid values: AppInstance : Billed by session Node : Billed by resource	Node
SkipUserAuthCheck	boolean	Indicates whether user authorization is skipped. Valid values: true : User authorization is skipped. false : User authorization is verified. This is the default value.	false
OfficeSiteId	string	The ID of the office network.	cn-beijing+dir-172301****
AppPolicyVersion	string	The policy version. Valid values: CENTER : Unified policy (new) DEFAULT : Default policy (legacy)	CENTER
AppPolicyImageCheck	boolean	Indicates whether the current image supports unified policies. Valid values: true : Supported false : Not supported	false
ResourceTags	array<object>	The tags attached to the resource.
	object	A resource tag.
Key	string	The tag key.	department
Value	string	The tag value.	design
Scope	string	The type of the tag. Valid values: Custom : Custom tag System : System tag	Custom
Tags	array<object>	The tags attached to the resource.
	object	A resource tag.
Key	string	The tag key.	department
Value	string	The tag value.	design
Scope	string	The type of the tag. Valid values: Custom : Custom tag System : System tag	Custom
AuthMode	string	The authorization model. Valid values: App : Application-based authorization AppInstanceGroup : App instance group-based authorization Session : Session-based authorization	App
AccessType	string	The access type. Valid values: INTERNET : Internet VPC : Virtual private cloud (VPC) ANY : Internet and virtual private cloud (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.