ListPublishedAppInstanceGroup-阿里云帮助中心

Queries published delivery groups and their application information for a specified product type under the current Alibaba Cloud account by using paging. Supports filtering by delivery group, application, and user authorization status.

Operation description

Before you begin

When calling this operation with a RAM user or STS credential, the appstreaming:ListPublishedAppInstanceGroup permission is required.

A delivery group must be in the published state and have deployed applications in its image to appear in the query results. This operation only queries information. It does not create delivery groups, assign users, or grant application access permissions.

Query and pagination

You must explicitly pass in ProductType, PageNumber, and PageSize. Page numbers start from 1, and the page size ranges from 1 to 100.
AppInstanceGroupId, AppInstanceGroupName, AppId, and AppName all support substring matching. You can pass them individually or in combination. When multiple conditions are specified, all conditions must be met simultaneously. When both AppId and AppName are specified, the same application must satisfy both conditions.
If an optional filter parameter is not specified or is set to an empty string, that condition is not applied. Query results are sorted by delivery group creation time from newest to oldest. A delivery group is not returned multiple times even if it contains multiple matching applications.
ExcludeUserId excludes delivery groups in which all applications have been directly authorized to the specified user. It cannot be used to determine whether the user has no access permissions at all.
AppId and AppName only filter delivery groups. They do not restrict the returned Apps list to only the matched applications.

Invoke sequence

Invoke a query with PageNumber=1 and the desired PageSize. For WUYING Cloud Application common scenarios, use ProductType=CloudApp.
Read AppInstanceGroupModels. To retrieve the next page, keep the product type and filter conditions unchanged and increment PageNumber. If no delivery groups match, the total count is 0 and the list is empty. If the page number exceeds the result range, the list may also be empty, but the total count still represents the total number of matching delivery groups.
To retrieve details of a single delivery group, pass the full AppInstanceGroupId from the response and the same ProductType to GetAppInstanceGroup.

The masked identifiers in the examples are for format demonstration purposes. Replace them with your actual identifiers when invoking the operation.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ProductType	string	Yes	The product type. This parameter is required. The value must match the product type of the delivery groups you want to query. Only published delivery groups of the specified product type are returned. A parameter error is returned if an unrecognized value is passed in. Valid values: `CloudApp`: WUYING Cloud Application. `CloudBrowser`: Cloud Browser. `WuyingServer`: Enterprise Workstation. `WuyingWorkstation`: Personal Edition Lingjou Container Workstation. `WuyingWorkstationTeam`: Team Edition Lingjou Container Workstation. `WuyingWorkstationBusiness`: Dedicated Edition Lingjou Container Workstation. `AndroidCloud`: Cloud Phone. `AIAgent`: AgentBay (AI agent). Valid values: WuyingWorkstation : Personal Edition Lingjou Container Workstation. WuyingWorkstationTeam : Team Edition Lingjou Container Workstation. CloudApp : WUYING Cloud Application. CloudBrowser : Cloud Browser. AIAgent : AgentBay (AI agent) AndroidCloud : Cloud Phone. WuyingWorkstationBusiness : Dedicated Edition Lingjou Container Workstation. WuyingServer : Enterprise Workstation.	CloudApp
PageNumber	integer	Yes	The page number. This parameter is required. Start from page `1` and use this parameter together with `PageSize`. Keep other filter conditions unchanged when querying subsequent pages.	1
PageSize	integer	Yes	The maximum number of delivery groups to return per page. This parameter is required. Valid values: `1` to `100`. Unit: delivery groups. Specify this value explicitly and do not rely on default values from other query operations.	10
AppInstanceGroupId	string	No	The delivery group ID used for filtering. Substring matching is supported. You can pass in a full ID or a consecutive segment of the ID. If this parameter is not specified or is set to an empty string, no filtering by ID is applied. This parameter can be used together with other filter conditions. Results must satisfy all conditions simultaneously.	aig-9ciijz60n4xsv****
AppInstanceGroupName	string	No	The delivery group name used for filtering. Substring matching is supported. For example, if you pass in `OfficeApps`, delivery groups whose names contain this text are matched. If this parameter is not specified or is set to an empty string, no filtering by name is applied. When specified together with the delivery group ID, both the ID and name must match.	OfficeApps
ExcludeUserId	string	No	The username to exclude based on existing authorization. Exact username matching is used, for example, `alice`. When specified, delivery groups in which all applications have been directly authorized to this user are excluded. If this parameter is not specified or is set to an empty string, no exclusion based on user authorization is applied. Authorization granted for individual applications only, or access permissions obtained through user groups, is not fully evaluated by this condition. Do not treat the returned results as a complete list of delivery groups that the user has no access permissions to.	alice
AppId	string	No	The application ID used for filtering delivery groups. Substring matching is supported. The delivery group must contain a deployed application that matches the condition. If this parameter is not specified or is set to an empty string, no filtering by application ID is applied. When specified together with `AppName`, the same application must satisfy both conditions. This condition does not trim the returned `Apps` list.	ca-i87mycyn419nu****
AppName	string	No	The application name used for filtering delivery groups. Substring matching is supported. The delivery group must contain a deployed application whose name includes the specified text. If this parameter is not specified or is set to an empty string, no filtering by application name is applied. When specified together with `AppId`, the same application must satisfy both conditions. This condition does not trim the returned `Apps` list.	OfficeApps

Response elements

Element	Type	Description	Example
	object	The result of this paging query, including the request ID, paging information, total number of matching delivery groups, and the delivery group list for the current page.
AppInstanceGroupModels	array<object>	The list of published delivery groups on the current page, sorted by creation time from newest to oldest. An empty list is returned if no results match or if the requested page exceeds the result range.
	array<object>	A published delivery group and the deployed application information in its image.
AppCenterImageId	string	The application image ID.	img-8z4nztpaqvay4****
AppInstanceGroupId	string	The delivery group ID.	aig-9ciijz60n4xsv****
AppInstanceGroupName	string	The delivery group name.	OfficeApps
AppInstanceType	string	The delivery group specification type.	__dynamic__
Apps	array<object>	The list of deployed applications in the delivery group image. The `AppId` and `AppName` parameters in the request only determine whether a delivery group is included in the results. They do not trim this list to only the matched applications.
	object	The identifier, name, version, and icon information of a deployed application.
AppIcon	string	The application icon.	https://app-center-icon-****.png
AppId	string	The application ID.	ca-i87mycyn419nu****
AppName	string	The application name.	OfficeApps
AppVersion	string	The application version.	1.0.0
AppVersionName	string	The application version name.	Initial version
ExpiredTime	string	The expiration time of the delivery group. For delivery groups sold as resources, this is the resource expiration time. For other delivery groups, this is the delivery group expiration time. The value is in ISO 8601 format with milliseconds and a time zone offset. The returned time zone offset is +00:00. Format: yyyy-MM-ddTHH:mm:ss.SSS+HH:mm.	2022-04-27T16:00:00.000+00:00
GmtCreate	string	The creation time of the delivery group. The value is in ISO 8601 format with milliseconds and a time zone offset. The returned time zone offset is +00:00. Format: yyyy-MM-ddTHH:mm:ss.SSS+HH:mm.	2022-04-26T15:06:16.000+00:00
RegionId	string	The region ID of the delivery group.	cn-hangzhou
Status	string	The delivery group status. This operation returns delivery groups only in the following status: `PUBLISHED`: Published and listed. The delivery group can appear in the query results of this operation. This status does not indicate that a specified user has been granted access permissions. Valid values: PUBLISHED : Published and listed.	PUBLISHED
PageNumber	integer	The page number specified in this request.	1
PageSize	integer	The number of delivery groups per page specified in the request. Unit: delivery groups. This value does not represent the actual number of delivery groups returned on the current page. The actual number on the current page may be less than this value.	10
RequestId	string	The request ID. You can use this ID to locate and troubleshoot issues.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TotalCount	integer	The total number of delivery groups that match all filter conditions. Unit: delivery groups. This value is not the number of delivery groups returned on the current page. Each delivery group is counted only once. The value is `0` if no results match.	15

Examples

Success response

JSON format

{
  "AppInstanceGroupModels": [
    {
      "AppCenterImageId": "img-8z4nztpaqvay4****",
      "AppInstanceGroupId": "aig-9ciijz60n4xsv****",
      "AppInstanceGroupName": "办公应用",
      "AppInstanceType": "__dynamic__",
      "Apps": [
        {
          "AppIcon": "https://app-center-icon-****.png",
          "AppId": "ca-i87mycyn419nu****",
          "AppName": "办公应用",
          "AppVersion": "1.0.0",
          "AppVersionName": "初始版本"
        }
      ],
      "ExpiredTime": "2022-04-27T16:00:00.000+00:00",
      "GmtCreate": "2022-04-26T15:06:16.000+00:00",
      "RegionId": "cn-hangzhou",
      "Status": "PUBLISHED"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "TotalCount": 15
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.