ListAppsByAppInstanceGroupId-阿里云帮助中心

Queries the deployed applications in the image used by a specified delivery group with paging and returns the number of users with per-application authorization for each application.

Operation description

This operation returns the list of deployed applications in the application image used by a specified delivery group, including the application ID, name, version, icon, and the number of users currently authorized by application for each application (AuthorizedUserCount).

The returned AppId is the input for per-application authorization: when you call the AuthorizeUsersForApp operation to add or remove authorized users for a specified application in a delivery group, pass in the AppId returned by this operation.

Before you begin

The delivery group is created, and ProductType matches the product type of the delivery group. If the delivery group does not exist or the product type does not match, the error code InvalidAppInstanceGroup.NotFound is returned.

Parameter description

AppInstanceGroupId is required. This parameter is marked as optional in the parameter table, but the error code InvalidParameter.AppInstanceGroupId is returned if it is not specified.
PageNumber starts from 1. Valid values of PageSize: 1 to 100. If the values are invalid, the error codes InvalidParameter.PageNumber and InvalidParameter.PageSize are returned respectively.
If no applications are deployed in the delivery group image, the operation returns normally: Apps is an empty list and TotalCount is 0.

Call sequence

Call the ListAppInstanceGroup operation to obtain the delivery group ID (AppInstanceGroupId).
Call this operation to obtain the list of deployed applications in the delivery group and the AppId of each application.
To authorize by application, call the AuthorizeUsersForApp operation with the returned AppId.

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. The value must match the product type of the delivery group specified by AppInstanceGroupId. Otherwise, the error code `InvalidAppInstanceGroup.NotFound` is returned. Valid values: CloudApp: WUYING Cloud Application. CloudBrowser: Cloud Browser. Valid values: CloudApp : WUYING Cloud Application. CloudBrowser : Cloud Browser.	CloudApp
PageNumber	integer	Yes	The page number. Pages start from page 1.	1
PageSize	integer	Yes	The number of applications to return per page. Valid values: 1 to 100.	10
AppInstanceGroupId	string	No	The delivery group ID. WUYING Cloud Application delivery group: call the ListAppInstanceGroup operation to obtain the ID. Cloud Browser group: specify the Cloud Browser group ID. Call the ListBrowserInstanceGroup operation to obtain the ID. Note This parameter is required. If it is not specified, the error code `InvalidParameter.AppInstanceGroupId` is returned.	aig-9ciijz60n4xsv****

Response elements

Element	Type	Description	Example
	object	Schema of Response
Apps	array<object>	The list of application information on the current page. This is an empty list if no deployed applications exist in the delivery group image.
	object
AppIcon	string	The URL of the application icon.	https://app-center-icon-****.png
AppId	string	The application ID. Pass in this value when you call the AuthorizeUsersForApp operation to authorize users for this application.	ca-i87mycyn419nu****
AppName	string	The application name.	OfficeApp
AppVersion	string	The application version number.	1.0.0
AppVersionName	string	The application version name.	InitialVersion
AuthorizedUserCount	integer	The number of users currently authorized by application for this application in the delivery group. The value 0 is returned if no users are authorized by application.	5
PageNumber	integer	The current page number, which is the same as the PageNumber request parameter.	1
PageSize	integer	The number of applications returned per page, which is the same as the PageSize request parameter.	10
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TotalCount	integer	The total number of deployed applications in the delivery group.	3

Examples

Success response

JSON format

{
  "Apps": [
    {
      "AppIcon": "https://app-center-icon-****.png",
      "AppId": "ca-i87mycyn419nu****",
      "AppName": "办公应用",
      "AppVersion": "1.0.0",
      "AppVersionName": "初始版本",
      "AuthorizedUserCount": 5
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "TotalCount": 3
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.