ListAppsByAppInstanceGroupId - 查询交付组内已部署的应用列表-无影云应用(App Streaming)-阿里云帮助中心

分页查询指定交付组使用的镜像中已部署的应用，并返回每个应用当前按应用授权的用户数量。

接口说明

本接口返回指定交付组使用的应用镜像中已部署的应用列表，包括应用 ID、名称、版本、图标，以及每个应用当前按应用授权的用户数量（AuthorizedUserCount）。

返回的 AppId 是按应用授权的输入：调用 AuthorizeUsersForApp 接口为交付组内的指定应用添加或移除授权用户时，需要传入本接口返回的 AppId。

前置条件

交付组已创建，且 ProductType 与该交付组的产品类型一致；交付组不存在或产品类型不匹配时，返回错误码 InvalidAppInstanceGroup.NotFound。

参数说明

AppInstanceGroupId 必须传入。参数表中该参数标记为非必填，但未传入时接口返回错误码 InvalidParameter.AppInstanceGroupId。
PageNumber 从 1 开始；PageSize 取值范围为 1~100。取值不合法时分别返回错误码 InvalidParameter.PageNumber、InvalidParameter.PageSize。
交付组镜像中没有已部署的应用时，接口正常返回：Apps 为空列表，TotalCount 为 0。

调用顺序

调用 ListAppInstanceGroup 接口，获取交付组 ID（AppInstanceGroupId）。
调用本接口，获取该交付组内已部署的应用列表及每个应用的 AppId。
如需按应用授权，根据返回的 AppId 调用 AuthorizeUsersForApp 接口。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ProductType	string	是	产品类型。取值需与 AppInstanceGroupId 所指交付组的产品类型一致，否则返回错误码 `InvalidAppInstanceGroup.NotFound`。取值： CloudApp：无影云应用。 CloudBrowser：云浏览器。枚举值： CloudApp : 无影云应用 CloudBrowser : 云浏览器	CloudApp
PageNumber	integer	是	查询页码，从第 1 页开始。	1
PageSize	integer	是	每页返回的应用数量。取值范围：1~100。	10
AppInstanceGroupId	string	否	交付组 ID。无影云应用交付组：可调用 ListAppInstanceGroup 接口获取。云浏览器组：传入云浏览器组 ID，可调用 ListBrowserInstanceGroup 接口获取。说明该参数必须传入。未传入时返回错误码 `InvalidParameter.AppInstanceGroupId`。	aig-9ciijz60n4xsv****

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Apps	array<object>	当前页的应用信息列表。交付组镜像中没有已部署的应用时为空列表。
	object
AppIcon	string	应用图标地址。	https://app-center-icon-****.png
AppId	string	应用 ID。调用 AuthorizeUsersForApp 接口为该应用授权用户时，传入此值。	ca-i87mycyn419nu****
AppName	string	应用名称。	办公应用
AppVersion	string	应用版本号。	1.0.0
AppVersionName	string	应用版本名称。	初始版本
AuthorizedUserCount	integer	该应用当前在交付组内按应用授权的用户数量。未按应用授权任何用户时返回 0。	5
PageNumber	integer	当前页码，与请求参数 PageNumber 一致。	1
PageSize	integer	每页返回的应用数量，与请求参数 PageSize 一致。	10
RequestId	string	请求 ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TotalCount	integer	该交付组内已部署应用的总数。	3

示例

正常返回示例

JSON格式

{
  "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
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。