分页查询当前阿里云账号下指定产品类型的已发布交付组中已部署的应用,返回每个应用及其所属交付组和按应用授权的用户数量,支持按交付组、应用和用户授权情况筛选。
接口说明
使用前提
使用 RAM 用户或 STS 凭证调用时,需要具有 appstreaming:ListPublishedApps 权限。
只有处于已发布状态的交付组,且其镜像中存在已部署的应用,对应的应用才会进入查询结果。本接口仅查询信息,不创建交付组,也不授予或移除应用访问权限。
返回粒度
结果按“交付组 + 应用”组合逐条返回:同一应用部署在多个已发布交付组中时,会分别返回多条记录;TotalCount 统计的也是组合数量。列表按所属交付组的创建时间从新到旧排序。
查询与分页
必须显式传入
ProductType、PageNumber和PageSize。 页码从1开始,每页数量为1~100;取值不合法时分别返回错误码InvalidParameter.PageNumber、InvalidParameter.PageSize。AppInstanceGroupId、AppInstanceGroupName、AppId、AppName均支持包含匹配;可单独传入,也可组合使用,多个条件须同时满足。可选筛选参数不传或传入空字符串时,不按该条件筛选。
ExcludeUserId用于排除已按应用授权给指定用户的应用,便于筛出仍可为该用户授权的应用;通过交付组整体授权或用户组获得的访问权限不由本条件判断。
调用顺序
以
PageNumber=1和所需PageSize发起查询;无影云应用场景使用ProductType=CloudApp。读取
Apps。需要下一页时,保持产品类型和筛选条件不变,递增PageNumber。没有匹配结果时,TotalCount为0且Apps为空列表;页码超出结果范围时Apps也可能为空,但TotalCount仍表示全部匹配记录数量。需要为某个应用按应用授权用户时,将返回的
AppInstanceGroupId、AppId和相同的ProductType传入 AuthorizeUsersForApp ;需要查看交付组详情时,将AppInstanceGroupId和ProductType传入 GetAppInstanceGroup 。
示例中的脱敏标识用于展示格式,调用时应替换为您的实际标识。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ProductType |
string |
是 |
产品类型,必填,取值不区分大小写。只返回该产品类型下已发布交付组中的应用;传入无法识别的取值时返回错误码 取值:
枚举值:
|
CloudApp |
| PageNumber |
integer |
是 |
查询页码,必填。请从第 |
1 |
| PageSize |
integer |
是 |
每页最多返回的应用记录数量,必填。取值范围为 |
10 |
| AppInstanceGroupId |
string |
否 |
用于筛选的交付组 ID,支持包含匹配。可传入完整 ID 或其中的连续片段;不传或为空字符串时不按交付组 ID 筛选。可调用 ListAppInstanceGroup 接口获取交付组 ID。可与其他筛选条件同时使用,结果须同时满足所有条件。 |
aig-9ciijz60n4xsv**** |
| AppInstanceGroupName |
string |
否 |
用于筛选的交付组名称,支持包含匹配。例如传入 |
办公应用 |
| AppId |
string |
否 |
用于筛选的应用 ID,支持包含匹配。可传入完整 ID 或其中的连续片段;不传或为空字符串时不按应用 ID 筛选。与 |
ca-i87mycyn419nu**** |
| AppName |
string |
否 |
用于筛选的应用名称,支持包含匹配。例如传入 |
办公应用 |
| ExcludeUserId |
string |
否 |
需要排除的用户名,按完整用户名匹配,例如 通过交付组整体授权或用户组获得的访问权限不由本条件判断。 不能据此把返回结果等同于该用户完全无权访问的应用列表。 |
alice |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
本次分页查询的结果,包括请求 ID、分页信息、匹配记录总数和当前页的应用列表。 |
||
| Apps |
array<object> |
当前页的应用记录列表,每条记录对应一个已发布交付组中的一个已部署应用,按所属交付组的创建时间从新到旧排序。没有匹配结果或请求页超出结果范围时,返回空列表。 |
|
|
object |
一个已发布交付组中的一个已部署应用,包含应用标识、版本、图标、所属交付组及按应用授权的用户数量。 |
||
| AppIcon |
string |
应用图标的访问地址。 |
https://app-center-icon-****.png |
| AppId |
string |
应用 ID。调用 AuthorizeUsersForApp 接口为该应用授权用户时,与 |
ca-i87mycyn419nu**** |
| AppInstanceGroupId |
string |
该应用所属已发布交付组的 ID。 |
aig-9ciijz60n4xsv**** |
| AppInstanceGroupName |
string |
该应用所属已发布交付组的名称。 |
办公应用 |
| AppName |
string |
应用名称。 |
办公应用 |
| AppVersion |
string |
应用版本号。 |
1.0.0 |
| AppVersionName |
string |
应用版本名称,即应用发布时为该版本设置的名称。 |
初始版本 |
| AuthorizedUserCount |
integer |
该应用当前在所属交付组内按应用授权的用户数量,单位为个。仅统计通过 AuthorizeUsersForApp 按应用授权的用户;未按应用授权任何用户时返回 |
5 |
| PageNumber |
integer |
本次请求指定的查询页码。 |
1 |
| PageSize |
integer |
本次请求指定的每页记录数量,单位为条。该值不表示当前页实际返回数量;当前页实际数量可能小于该值。 |
10 |
| RequestId |
string |
本次请求的唯一标识,可用于定位请求问题。 |
1CBAFFAB-B697-4049-A9B1-67E1FC5F**** |
| TotalCount |
integer |
符合全部筛选条件的记录总数,单位为条。按“交付组 + 应用”组合计数,同一应用出现在多个已发布交付组中时分别计入;该值不是当前页返回数量,没有匹配结果时为 |
15 |
示例
正常返回示例
JSON格式
{
"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
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。