ListPublishedApps-阿里云帮助中心

Queries deployed applications in published delivery groups under the current Alibaba Cloud account for a specified product type by paging, and returns each application along with its delivery group and the number of authorized users by application. Supports filtering by delivery group, application, and user authorization status.

Operation description

Before you begin

When you call this operation by using a RAM user or Security Token Service (STS) credential, you must have the appstreaming:ListPublishedApps permission.

Only delivery groups in the published state whose images contain deployed applications are included in the query results. This operation only queries information. It does not create delivery groups or grant or revoke application access permissions.

Response granularity

Results are returned on a per-delivery-group-plus-application basis. If the same application is deployed in multiple published delivery groups, a separate record is returned for each combination. TotalCount also reflects the number of such combinations. The list is sorted by the creation time of the delivery group in descending order.

Query and pagination

You must explicitly specify ProductType, PageNumber, and PageSize. Page numbers start from 1, and the page size ranges from 1 to 100. Invalid values return error codes InvalidParameter.PageNumber and InvalidParameter.PageSize, respectively.
AppInstanceGroupId, AppInstanceGroupName, AppId, and AppName all support substring matching. You can specify them individually or in combination. When multiple conditions are specified, all conditions must be met.
If an optional filter parameter is not specified or is set to an empty string, filtering is not applied for that condition.
ExcludeUserId excludes applications that have been authorized to the specified user by application, which helps you find applications that can still be authorized to that user. Access permissions granted through delivery-group-level authorization or user groups are not evaluated by this condition.

Invocation sequence

Initiate a query with PageNumber=1 and the desired PageSize. For WUYING Cloud Application common scenarios, use ProductType=CloudApp.
Read Apps. To retrieve the next page, increment PageNumber while keeping the product type and filter conditions unchanged. If no results match, TotalCount is 0 and Apps is an empty list. If the page number exceeds the result range, Apps may also be empty, but TotalCount still indicates the total number of matching records.
To authorize users for a specific application by application, pass the returned AppInstanceGroupId, AppId, and the same ProductType to AuthorizeUsersForApp. To view delivery group details, pass AppInstanceGroupId and ProductType to GetAppInstanceGroup.

The masked identities in the examples are for format demonstration purposes. Replace them with your actual identities when you invoke 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 is case-insensitive. Only applications in published delivery groups of the specified product type are returned. If an unrecognized value is specified, the error code `InvalidParameter.ProductType` is returned. Filtering and statistics related to per-application authorization (`ExcludeUserId` and `AuthorizedUserCount`) are primarily used in WUYING Cloud Application common scenarios. 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. If an invalid value is specified, the error code `InvalidParameter.PageNumber` is returned.	1
PageSize	integer	Yes	The maximum number of application records to return per page. This parameter is required. Valid values: `1` to `100`. If the value is out of range, the error code `InvalidParameter.PageSize` is returned.	10
AppInstanceGroupId	string	No	The delivery group ID used for filtering. Substring matching is supported. You can specify a complete ID or a consecutive segment of it. If this parameter is not specified or is set to an empty string, filtering by delivery group ID is not applied. You can call the ListAppInstanceGroup operation to obtain delivery group IDs. This parameter can be used together with other filter conditions, and all conditions must be met simultaneously.	aig-9ciijz60n4xsv****
AppInstanceGroupName	string	No	The delivery group name used for filtering. Substring matching is supported. For example, if you specify `OfficeApps`, delivery groups whose names contain this text are matched. If this parameter is not specified or is set to an empty string, filtering by delivery group name is not applied. If both this parameter and the delivery group ID are specified, both conditions must be met.	OfficeApps
AppId	string	No	The application ID used for filtering. Substring matching is supported. You can specify a complete ID or a consecutive segment of it. If this parameter is not specified or is set to an empty string, filtering by application ID is not applied. If both this parameter and `AppName` are specified, both conditions must be met by the same application.	ca-i87mycyn419nu****
AppName	string	No	The application name used for filtering. Substring matching is supported. For example, if you specify `OfficeApps`, applications whose names contain this text are matched. If this parameter is not specified or is set to an empty string, filtering by application name is not applied. If both this parameter and `AppId` are specified, both conditions must be met by the same application.	OfficeApps
ExcludeUserId	string	No	The username to exclude. Exact username matching is used. For example, `alice`. When specified, applications that have been authorized to this user through AuthorizeUsersForApp by application are not returned. This helps you find applications that can still be authorized to the user. If this parameter is not specified or is set to an empty string, no exclusion based on user authorization is applied. Access permissions granted through delivery-group-level authorization or user groups are not evaluated by this condition. The returned results cannot be treated as a complete list of applications that the user has no access to.	alice

Response elements

Element	Type	Description	Example
	object	The result of this paged query, including the request ID, pagination information, total number of matching records, and the application list for the current page.
Apps	array<object>	The list of application records on the current page. Each record corresponds to a deployed application in a published delivery group. The list is sorted by the creation time of the delivery group in descending order. An empty list is returned if no results match or the requested page exceeds the result range.
	object	A deployed application in a published delivery group, including the application identifier, version, icon, the delivery group it belongs to, and the number of users authorized by application.
AppIcon	string	The URL of the application icon.	https://app-center-icon-****.png
AppId	string	The application ID. Pass this value together with `AppInstanceGroupId` when you invoke the AuthorizeUsersForApp operation to authorize users for this application.	ca-i87mycyn419nu****
AppInstanceGroupId	string	The ID of the published delivery group to which this application belongs.	aig-9ciijz60n4xsv****
AppInstanceGroupName	string	The name of the published delivery group to which this application belongs.	OfficeApps
AppName	string	The application name.	OfficeApps
AppVersion	string	The application version number.	1.0.0
AppVersionName	string	The application version name, which is the name assigned to this version when the application was published.	Initial version
AuthorizedUserCount	integer	The number of users authorized by application for this application within its delivery group. Only users authorized through AuthorizeUsersForApp by application are counted. The value is `0` if no users have been authorized by application.	5
PageNumber	integer	The page number specified in this request.	1
PageSize	integer	The number of records per page specified in this request. This value does not represent the actual number of records returned on the current page. The actual number 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 records that match all filter conditions. Records are counted on a per-delivery-group-plus-application basis. If the same application appears in multiple published delivery groups, each combination is counted separately. This value does not represent the number of records returned on the current page. The value is `0` if no results match.	15

Examples

Success response

JSON format

{
  "Apps": [
    {
      "AppIcon": "https://app-center-icon-****.png",
      "AppId": "ca-i87mycyn419nu****",
      "AppInstanceGroupId": "aig-9ciijz60n4xsv****",
      "AppInstanceGroupName": "办公应用",
      "AppName": "办公应用",
      "AppVersion": "1.0.0",
      "AppVersionName": "初始版本",
      "AuthorizedUserCount": 5
    }
  ],
  "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.