ListTenantApp - 查询租户应用列表-无影云电脑企业版-阿里云帮助中心

分页查询当前租户可见的桌面应用，支持按应用名称和来源筛选。

接口说明

查询范围由调用身份确定，包括当前租户上传的应用及该租户有权查看的市场应用。市场应用的可见性受授权及展示策略限制。列表中的授权和自动安装信息表示应用配置，不代表应用在某台终端上的实际安装结果。

应用标识：Id 是数值应用 ID，AppUid 是字符串 UID，二者不能互换。
授权范围：DistributeType 与 AuthType 配合使用。例如，AuthType=auth_type_user、DistributeType=ALL 表示按用户维度全部分配。
自动安装：AutoInstallmentType 表示自动安装范围策略，用于区分全部、部分或关闭自动安装。
部分自动安装：AutoInstallmentType 为 1 时，通过 SetAutoInstallUser 或 SetAutoInstallDesktop 配置具体用户或云电脑；OperationType=1 表示开启，OperationType=2 表示关闭。ListTenantApp 仅返回配置，不修改自动安装设置。
能力与执行结果：静默安装能力是返回的应用元信息。判断终端实际安装或执行成功情况，需要使用对应的执行结果查询能力。
可选信息：时间等信息可能为空。
兼容处理：扩展信息和子类型不采用封闭枚举。客户端应忽略不认识的扩展字段，并兼容新枚举值。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecd:ListTenantApp

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
OsType	string	否	操作系统	Windows
KeyName	string	否	应用名称关键词，按包含关系匹配。未传或传空串时不按名称筛选；`%` 可作为通配符，`_` 按普通字符匹配。	示例编辑器
SourceType	string	否	应用来源：MARKET 表示市场应用，TENANT 表示当前租户上传的应用。省略时查询两类可见应用。	TENANT
PageNumber	integer	否	页码，从 1 开始。未传或小于等于 0 时使用 1。	1
PageSize	integer	否	每页条数，有效范围 1～500。未传、小于等于 0 或大于 500 时使用 20。	20

本次对外调用仅需关注 RegionId、KeyName、SourceType、PageNumber、PageSize。RegionId 为调用地域，例如 cn-hangzhou，请使用服务已开放的地域。Action 固定为 ListTenantApp，Version 固定为 2021-06-02。参数名及枚举值区分大小写。

查询名称包含“示例编辑器”的租户上传应用：

Action=ListTenantApp
Version=2021-06-02
RegionId=cn-hangzhou
PageNumber=1
PageSize=20
KeyName=示例编辑器
SourceType=TENANT

使用服务提供的 endpoint 及认证方式发送请求。中文与特殊字符需要 URL 编码。查询市场应用时将 SourceType 改为 MARKET；查询所有可见来源时省略 SourceType。

返回参数

名称	类型	描述	示例值
	object
Code	string	业务结果码，类型为字符串；成功时通常为 "200"。	200
Data	array<object>	当前页应用列表，每个元素表示一个应用。
	object
AdminTag	array	内部字段，不建议使用。
	string	内部字段，不建议使用。	推荐
AppAdminTag	string	内部字段，不建议使用。	推荐
AppRegInfo	string	应用注册表识别信息，以字符串形式返回，可用于匹配应用注册表条目的名称。	示例编辑器
AppTag	array	内部字段，不建议使用。
	string	内部字段，不建议使用。	办公
AppUid	string	应用 UID 字符串，与数值类型 Id 是不同标识。	app-demo-001
AuthType	string	应用授权维度，取值说明：auth_type_user：按用户授权；auth_type_resource_group：按资源组授权。	auth_type_user
AutoDeleteFlag	boolean	已废弃
AutoInstallFlag	boolean	已废弃
AutoInstallType	string	已废弃	SILENCE_INSTALL
AutoInstallmentType	integer	新版自动安装范围策略，结合 AuthType 判断授权维度。取值：0 表示为全部可见用户或资源组自动安装；1 表示为部分可见用户或资源组自动安装；2 表示关闭自动安装；99 表示未知策略。该字段描述配置范围，不代表终端已完成安装。	1
CateId	integer	应用展示类目 ID。类目 ID 为动态标识，不是固定枚举。	1001
CateName	string	应用展示类目名称。	办公
ClusterUid	string	已废弃	cluster-demo-001
Description	string	应用描述。	用于文档编辑
Developer	string	应用开发者名称。	示例软件公司
DiscountPrice	number	已废弃	0
DistributeType	string	应用授权分配范围，枚举见下文；必须结合 AuthType 解读。为空不能直接解释为不分配。取值说明：ALL：全部分配；DESIGNATED：指定范围分配；NOTDISTRO：不分配；UNKNOWN：未知范围。分配对象由 AuthType 决定。	ALL
ExpireTime	string	应用授权结束时间。以带时区的字符串返回，依次包含日期、字母 T、时分秒、3 位毫秒及不带冒号的时区偏移；示例中的 +0000 表示 UTC。无值时可能为空或不返回。	2026-10-07T00:00:00.000+0000
Extend	string	应用扩展信息，以字符串形式返回；没有统一固定字段结构。	{}
FileName	string	安装包的存储文件名，可能与原始文件名不同。	editor_1.2.3.exe
FilePath	string	安装包存储路径；该值不等于可直接访问的下载 URL。	packages/example/editor.exe
FileRealName	string	安装包的原始文件名。	editor.exe
GmtCreate	string	应用记录创建时间。以带时区的字符串返回，依次包含日期、字母 T、时分秒、3 位毫秒及不带冒号的时区偏移；示例中的 +0000 表示 UTC。无值时可能为空或不返回。	2026-09-07T09:04:38.000+0000
GmtModified	string	应用记录最近修改时间。以带时区的字符串返回，依次包含日期、字母 T、时分秒、3 位毫秒及不带冒号的时区偏移；示例中的 +0000 表示 UTC。无值时可能为空或不返回。	2026-09-07T09:04:38.000+0000
HasCert	boolean	已废弃
IconUrl	string	应用图标 URL。	https://example.com/icons/editor.png
IconUrlInternal	string	应用内网图标 URL，仅在具备相应网络访问条件时使用。示例域名仅用于说明 URL 格式。	https://example.com/icons/editor.png
Id	integer	应用数值 ID，用于标识应用及关联后续操作。	10001
Install	boolean	已废弃
InstallMode	integer	已废弃	0
IsAdmin	boolean	是否配置提权安装：true 是，false 否。不是调用者的管理员身份。取值说明：true、false。具体业务含义见对应字段说明。	false
IsFree	string	已废弃	TRUE
IsGame	boolean	已废弃
IsWhiteList	integer	内部字段，不建议使用。	0
ItemCode	string	已废弃	app-demo-001
Labels	string	内部字段，不建议使用。	办公
LicenseType	string	内部字段，不建议使用。	MANUAL
ManageCateEnName	string	应用管理类目的英文名称。	Office
ManageCateId	integer	应用管理类目 ID，可能与展示类目 CateId 不同。	1001
ManageCateName	string	应用管理类目名称。	办公
Name	string	应用名称。	示例编辑器
OriginAppType	string	应用形态，取值说明：ClientBase：客户端应用；WebBase：Web 应用。	ClientBase
OriginalPrice	number	已废弃	0
OsDistributions	array	发行版
	string	发行版	Ubuntu
OsType	string	应用操作系统类型，取值说明：WINDOWS：Windows；LINUX：Linux；ANDROID：Android；UNKNOWN：未知操作系统。	WINDOWS
OwnerOs	string	已废弃	WINDOWS
PaymentType	integer	已废弃	0
Price	string	已废弃	0
Priority	integer	已废弃	0
PublishDate	string	应用发布时间。以带时区的字符串返回，依次包含日期、字母 T、时分秒、3 位毫秒及不带冒号的时区偏移；示例中的 +0000 表示 UTC。无值时可能为空或不返回。	2026-09-07T09:04:39.000+0000
PublishType	string	应用面向的客户范围，取值说明：ENT：企业；PER：个人；BOTH：企业和个人。	ENT
SandboxMode	integer	已废弃	0
SearchTag	string	内部字段，不建议使用。	编辑文档
SilenceDeleteFlag	integer	已废弃	1
SilenceDeleteParam	string	已废弃	/uninstall /quiet
SilenceFlag	integer	是否支持静默安装：0 表示不支持，1 表示支持。该字段表示应用能力，不代表实际安装执行结果。	1
SilenceParam	string	静默安装参数，供相应安装流程使用。	/quiet
Size	integer	安装包大小。	10485760
SourceType	string	应用来源，取值说明：MARKET：市场应用；TENANT：租户上传应用；UNKNOWN：未知来源。	TENANT
StartTime	string	应用授权开始时间。以带时区的字符串返回，依次包含日期、字母 T、时分秒、3 位毫秒及不带冒号的时区偏移；示例中的 +0000 表示 UTC。无值时可能为空或不返回。	2026-09-07T00:00:00.000+0000
Status	string	应用状态，此字段不代表终端安装状态。取值说明：NORMAL：正常；DELETE：已删除；UNCHECK：未审核／未检验；DISABLE：所有版本不可用；UNKNOWN：未知状态。沙箱打包发布流程的历史状态已废弃，请勿使用：UNPACKED（未打包）、TESTING（已打包、待测试）、UNPUBLISHED（测试完成、未发布）、PUBLISHED（已发布）。	NORMAL
SubAppType	string	已废弃	sandbox
SubSourceType	string	应用的二级来源，取值说明：ALI_MARKET：云市场；ISV：软件服务商；OPS：运营渠道；UNKNOWN：未知来源。	ISV
SubscribeCount	integer	已废弃	0
SupplierId	integer	应用供应方或上传方的账号 ID。	1234567890123456
UserTag	array	内部字段，不建议使用。
	string	内部字段，不建议使用。	推荐
Version	string	应用版本号。	1.2.3
VersionName	string	应用版本的展示名称。	1.2.3 正式版
WamFileName	string	已废弃	editor_1.2.3.wam
WamFilePath	string	已废弃	packages/example/editor.wam
WamFileRealName	string	已废弃	editor.wam
WamFileSize	integer	已废弃	1024
HttpStatusCode	integer	业务响应中的 HTTP 状态码字段，可能为空；实际传输状态以 HTTP 响应状态为准。	200
Message	string	请求处理结果说明。	success
PageNumber	integer	实际查询页码。	1
PageSize	integer	实际采用的每页条数。	20
RequestId	string	请求跟踪 ID，反馈调用问题时请提供该值。	11111111-2222-4333-8444-555555555555
Success	boolean	请求处理是否成功：true 成功，false 失败。取值说明：true、false。具体业务含义见对应字段说明。	true
TotalCount	integer	满足筛选条件的应用总数，不等于当前页数组长度。	1

响应字段无需调用方填写。部分字段只适用于特定应用类型、来源或授权配置，可能为空或不返回。客户端应兼容字段缺失、null 和后续新增字段；不得将 null 自动解释为 0、false 或未授权。

示例展示常用字段，其余返回字段的类型和含义见完整返回参数表。一次响应不保证包含全部字段。

{
  "RequestId": "11111111-2222-4333-8444-555555555555",
  "Success": true,
  "Code": "200",
  "Message": "success",
  "HttpStatusCode": null,
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 1,
  "Data": [
    {
      "Id": 10001,
      "Name": "示例编辑器",
      "Version": "1.2.3",
      "VersionName": "1.2.3 正式版",
      "SourceType": "TENANT",
      "OriginAppType": "ClientBase",
      "OsType": "WINDOWS",
      "Description": "用于文档编辑",
      "DistributeType": "ALL",
      "AuthType": "auth_type_user",
      "AutoInstallmentType": 1,
      "IsAdmin": false
    }
  ]
}

本例表示应用按用户维度全部授权，AutoInstallmentType=1 表示仅对部分可见用户启用自动安装。

空结果示例

{
  "RequestId": "66666666-7777-4888-8999-000000000000",
  "Success": true,
  "Code": "200",
  "Message": "success",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 0,
  "Data": []
}

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Data": [
    {
      "AdminTag": [
        "推荐"
      ],
      "AppAdminTag": "推荐",
      "AppRegInfo": "示例编辑器",
      "AppTag": [
        "办公"
      ],
      "AppUid": "app-demo-001",
      "AuthType": "auth_type_user",
      "AutoDeleteFlag": true,
      "AutoInstallFlag": true,
      "AutoInstallType": "SILENCE_INSTALL",
      "AutoInstallmentType": 1,
      "CateId": 1001,
      "CateName": "办公",
      "ClusterUid": "cluster-demo-001",
      "Description": "用于文档编辑",
      "Developer": "示例软件公司",
      "DiscountPrice": 0,
      "DistributeType": "ALL",
      "ExpireTime": "2026-10-07T00:00:00.000+0000",
      "Extend": "{}",
      "FileName": "editor_1.2.3.exe",
      "FilePath": "packages/example/editor.exe",
      "FileRealName": "editor.exe",
      "GmtCreate": "2026-09-07T09:04:38.000+0000",
      "GmtModified": "2026-09-07T09:04:38.000+0000",
      "HasCert": true,
      "IconUrl": "https://example.com/icons/editor.png",
      "IconUrlInternal": "https://example.com/icons/editor.png",
      "Id": 10001,
      "Install": true,
      "InstallMode": 0,
      "IsAdmin": false,
      "IsFree": "TRUE",
      "IsGame": true,
      "IsWhiteList": 0,
      "ItemCode": "app-demo-001",
      "Labels": "办公",
      "LicenseType": "MANUAL",
      "ManageCateEnName": "Office",
      "ManageCateId": 1001,
      "ManageCateName": "办公",
      "Name": "示例编辑器",
      "OriginAppType": "ClientBase",
      "OriginalPrice": 0,
      "OsDistributions": [
        "Ubuntu"
      ],
      "OsType": "WINDOWS",
      "OwnerOs": "WINDOWS",
      "PaymentType": 0,
      "Price": "0",
      "Priority": 0,
      "PublishDate": "2026-09-07T09:04:39.000+0000",
      "PublishType": "ENT",
      "SandboxMode": 0,
      "SearchTag": "编辑 文档",
      "SilenceDeleteFlag": 1,
      "SilenceDeleteParam": "/uninstall /quiet",
      "SilenceFlag": 1,
      "SilenceParam": "/quiet",
      "Size": 10485760,
      "SourceType": "TENANT",
      "StartTime": "2026-09-07T00:00:00.000+0000",
      "Status": "NORMAL",
      "SubAppType": "sandbox",
      "SubSourceType": "ISV",
      "SubscribeCount": 0,
      "SupplierId": 1234567890123456,
      "UserTag": [
        "推荐"
      ],
      "Version": "1.2.3",
      "VersionName": "1.2.3 正式版",
      "WamFileName": "editor_1.2.3.wam",
      "WamFilePath": "packages/example/editor.wam",
      "WamFileRealName": "editor.wam",
      "WamFileSize": 1024
    }
  ],
  "HttpStatusCode": 200,
  "Message": "success",
  "PageNumber": 1,
  "PageSize": 20,
  "RequestId": "11111111-2222-4333-8444-555555555555",
  "Success": true,
  "TotalCount": 1
}

错误码

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

变更历史

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