ListTenantApp-阿里云帮助中心

Performs a paging query of desktop applications visible to the current tenant, with support for filtering by application name and source.

Operation description

The query scope is determined by the caller identity and includes applications uploaded by the current tenant and marketplace applications that the tenant is authorized to view. The visibility of marketplace applications is subject to authorization and display policy restrictions. The authorization and auto-installation information in the list represents application configurations and does not indicate the actual installation result on a specific terminal.

Application identity: Id is the numeric application ID, and AppUid is the string UID. The two cannot be used interchangeably.
Authorization scope: DistributeType is used together with AuthType. For example, AuthType=auth_type_user and DistributeType=ALL indicate that the application is allocated to all users on a per-user dimension.
Auto-installation: AutoInstallmentType specifies the auto-installation scope policy, which is used to distinguish between full, partial, or disabled auto-installation.
Partial auto-installation: When AutoInstallmentType is set to 1, use SetAutoInstallUser or SetAutoInstallDesktop to configure specific users or cloud desktops. OperationType=1 indicates enabled, and OperationType=2 indicates disabled. ListTenantApp only returns configurations and does not modify auto-installation settings.
Capabilities and execution results: The silent installation capability is application metadata returned in the response. To determine the actual installation or execution result on a terminal, use the corresponding execution result query capability.
Optional information: Information such as timestamps may be empty.
Compatibility handling: Extension information and subtype do not use closed enumerations. Clients should ignore unrecognized extension fields and be compatible with new enumeration values.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecd:ListTenantApp

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
KeyName	string	No	The operating system.	Windows
SourceType	string	No	The application name keyword, matched by containment. If this parameter is not specified or is set to an empty string, no name-based filtering is applied. `%` can be used as a wildcard, and `_` is matched as a literal character.	SampleEditor
PageNumber	integer	No	The application source. MARKET indicates a marketplace application, and TENANT indicates an application uploaded by the current tenant. If this parameter is not specified, both types of visible applications are queried.	TENANT
PageSize	integer	No	The page number, starting from 1. If this parameter is not specified or is set to a value less than or equal to 0, the value 1 is used.	1

For this API call, focus on RegionId, KeyName, SourceType, PageNumber, and PageSize. RegionId specifies the region, such as cn-hangzhou. Use a region where the service is available. Action is fixed to ListTenantApp, and Version is fixed to 2021-06-02. Parameter names and enum values are case-sensitive.

Query tenant-uploaded applications whose names contain "SampleEditor":

Action=ListTenantApp
Version=2021-06-02
RegionId=cn-hangzhou
PageNumber=1
PageSize=20
KeyName=SampleEditor
SourceType=TENANT

Send the request by using the endpoint and authentication method provided by the service. URL-encode Chinese characters and special characters. To query marketplace applications, set SourceType to MARKET. To query all visible sources, omit SourceType.

Response elements

Element	Type	Description	Example
	object
Code	string	The business result code, returned as a string. The value is typically "200" when the request is successful.	200
Data	array<object>	The list of applications on the current page. Each element represents an application.
	object
AdminTag	array	An internal field. We do not recommend that you use this field.
	string	An internal field. We do not recommend that you use this field.	Recommended
AppAdminTag	string	An internal field. We do not recommend that you use this field.	Recommended
AppRegInfo	string	The application registry identification information, returned as a string. This value can be used to match the name of an application registry entry.	SampleEditor
AppTag	array	An internal field. We do not recommend that you use this field.
	string	An internal field. We do not recommend that you use this field.	Office
AppUid	string	The application UID string, which is a different identifier from the numeric Id field.	app-demo-001
AuthType	string	The authorization dimension of the application. Valid values: auth_type_user: Authorized by user. auth_type_resource_group: Authorized by resource group.	auth_type_user
AutoDeleteFlag	boolean	[Deprecated]
AutoInstallFlag	boolean	[Deprecated]
AutoInstallType	string	[Deprecated]	SILENCE_INSTALL
AutoInstallmentType	integer	The new auto-installation scope policy. Use this field together with AuthType to determine the authorization dimension. Valid values: 0: Automatically install for all visible users or resource groups. 1: Automatically install for some visible users or resource groups. 2: Disable auto-installation. 99: Unknown policy. This field describes the configuration scope and does not indicate that the installation has been completed on the endpoint.	1
CateId	integer	The display category ID of the application. The category ID is a dynamic identifier and is not a fixed enumeration.	1001
CateName	string	The display category name of the application.	Office
ClusterUid	string	[Deprecated]	cluster-demo-001
Description	string	The description of the application.	Used for document editing
Developer	string	The name of the application developer.	Sample Software Company
DiscountPrice	number	[Deprecated]	0
DistributeType	string	The authorization distribution scope of the application. This field must be interpreted together with AuthType. An empty value does not necessarily mean that the application is not distributed. Valid values: ALL: Distributed to all. DESIGNATED: Distributed to a specified scope. NOTDISTRO: Not distributed. UNKNOWN: Unknown scope. The distribution target is determined by AuthType.	ALL
ExpireTime	string	The authorization end time of the application. The value is returned as a string with a time zone, in the format of date, the letter T, hours-minutes-seconds, 3-digit milliseconds, and a time zone offset without colons. The +0000 in the example indicates UTC. This field may be empty or not returned if no value is available.	2026-10-07T00:00:00.000+0000
Extend	string	The extended information of the application, returned as a string. There is no unified fixed field structure.	{}
FileName	string	The storage file name of the installation package, which may differ from the original file name.	editor_1.2.3.exe
FilePath	string	The storage path of the installation package. This value is not a directly accessible download URL.	packages/example/editor.exe
FileRealName	string	The original file name of the installation package.	editor.exe
GmtCreate	string	The creation time of the application record. The value is returned as a string with a time zone, in the format of date, the letter T, hours-minutes-seconds, 3-digit milliseconds, and a time zone offset without colons. The +0000 in the example indicates UTC. This field may be empty or not returned if no value is available.	2026-09-07T09:04:38.000+0000
GmtModified	string	The last modification time of the application record. The value is returned as a string with a time zone, in the format of date, the letter T, hours-minutes-seconds, 3-digit milliseconds, and a time zone offset without colons. The +0000 in the example indicates UTC. This field may be empty or not returned if no value is available.	2026-09-07T09:04:38.000+0000
HasCert	boolean	[Deprecated]
IconUrl	string	The icon URL of the application.	https://example.com/icons/editor.png
IconUrlInternal	string	The internal network icon URL of the application. Use this URL only when the corresponding network access conditions are met. The domain name in the example is for illustrative purposes only.	https://example.com/icons/editor.png
Id	integer	The numeric ID of the application, used as the identity of the application and to associate what to do next.	10001
Install	boolean	[Deprecated]
InstallMode	integer	[Deprecated]	0
IsAdmin	boolean	Specifies whether privileged installation is configured. This does not indicate the administrator identity of the caller. Valid values: true: Privileged installation is configured. false: Privileged installation is not configured.	false
IsFree	string	[Deprecated]	TRUE
IsGame	boolean	[Deprecated]
IsWhiteList	integer	An internal field. We do not recommend that you use this field.	0
ItemCode	string	[Deprecated]	app-demo-001
Labels	string	An internal field. We do not recommend that you use this field.	Office
LicenseType	string	An internal field. We do not recommend that you use this field.	MANUAL
ManageCateEnName	string	The English name of the management category of the application.	Office
ManageCateId	integer	The management category ID of the application, which may differ from the display category CateId.	1001
ManageCateName	string	The management category name of the application.	Office
Name	string	The name of the application.	SampleEditor
OriginAppType	string	The application type. Valid values: ClientBase: Client-based application. WebBase: Web-based application.	ClientBase
OriginalPrice	number	[Deprecated]	0
OsDistributions	array	The distribution.
	string	The distribution.	Ubuntu
OsType	string	The operating system type of the application. Valid values: WINDOWS: Windows. LINUX: Linux. ANDROID: Android. UNKNOWN: Unknown operating system.	WINDOWS
OwnerOs	string	[Deprecated]	WINDOWS
PaymentType	integer	[Deprecated]	0
Price	string	[Deprecated]	0
Priority	integer	[Deprecated]	0
PublishDate	string	The publish time of the application. The value is returned as a string with a time zone, in the format of date, the letter T, hours-minutes-seconds, 3-digit milliseconds, and a time zone offset without colons. The +0000 in the example indicates UTC. This field may be empty or not returned if no value is available.	2026-09-07T09:04:39.000+0000
PublishType	string	The target customer scope of the application. Valid values: ENT: Enterprise. PER: Individual. BOTH: Enterprise and individual.	ENT
SandboxMode	integer	[Deprecated]	0
SearchTag	string	An internal field. We do not recommend that you use this field.	Edit Document
SilenceDeleteFlag	integer	[Deprecated]	1
SilenceDeleteParam	string	[Deprecated]	/uninstall /quiet
SilenceFlag	integer	Indicates whether silent installtion is supported. A value of 0 indicates that silent installtion is not supported. A value of 1 indicates that silent installtion is supported. This field indicates the application capability and does not represent the actual installation execute result.	1
SilenceParam	string	The silent installtion parameter, which is used in the corresponding installation flow.	/quiet
Size	integer	The size of the installation package.	10485760
SourceType	string	The application source. Valid values: MARKET: marketplace application. TENANT: tenant-uploaded application. UNKNOWN: unknown source.	TENANT
StartTime	string	The start time of the application authorization. The value is returned as a string with a time zone, which contains the date, the letter T, hours, minutes, seconds, 3-digit milliseconds, and a time zone offset without colons. The +0000 in the example indicates UTC. This field may be empty or not returned if no value is available.	2026-09-07T00:00:00.000+0000
Status	string	The application status. This field does not represent the installation status on the endpoint. Valid values: NORMAL: Normal. DELETE: Deleted. UNCHECK: Not reviewed or not verified. DISABLE: All versions are unavailable. UNKNOWN: Unknown status. The following historical statuses from the sandbox packaging and publishing process are deprecated and must not be used: UNPACKED (not packaged), TESTING (packaged, pending testing), UNPUBLISHED (testing completed, not published), PUBLISHED (published).	NORMAL
SubAppType	string	[Deprecated]	sandbox
SubSourceType	string	The secondary source of the application. Valid values: ALI_MARKET: Alibaba Cloud Marketplace. ISV: independent software vendor. OPS: operations channel. UNKNOWN: unknown source.	ISV
SubscribeCount	integer	[Deprecated]	0
SupplierId	integer	The account ID of the application supplier or uploader.	1234567890123456
UserTag	array	An internal field. We do not recommend that you use this field.
	string	An internal field. We do not recommend that you use this field.	Recommended
Version	string	The application version number.	1.2.3
VersionName	string	The display name of the application version.	1.2.3 Release
WamFileName	string	[Deprecated]	editor_1.2.3.wam
WamFilePath	string	[Deprecated]	packages/example/editor.wam
WamFileRealName	string	[Deprecated]	editor.wam
WamFileSize	integer	[Deprecated]	1024
HttpStatusCode	integer	The HTTP status code field in the business response. This field may be empty. The actual transmission status is determined by the HTTP response status.	200
Message	string	The description of the request processing result.	success
PageNumber	integer	The actual query page number.	1
PageSize	integer	The actual number of entries per page.	20
RequestId	string	The request tracking ID. Provide this value when reporting issues.	11111111-2222-4333-8444-555555555555
Success	boolean	Indicates whether the request was processed successfully. A value of true indicates success. A value of false indicates failure. Valid values: true false For specific business meanings, refer to the corresponding field descriptions.	true
TotalCount	integer	The total number of applications that match the filter conditions. This value is not equal to the length of the array on the current page.	1

Response fields do not need to be specified by the caller. Some fields apply only to specific application types, sources, or authorization configurations, and may be empty or not returned. The client must be compatible with missing fields, null values, and fields added in the future. Do not automatically interpret null as 0, false, or unauthorized.

The following example shows common fields. For the types and descriptions of other response fields, see the complete response elements table. A single response is not guaranteed to contain all fields.

{
  "RequestId": "11111111-2222-4333-8444-555555555555",
  "Success": true,
  "Code": "200",
  "Message": "success",
  "HttpStatusCode": null,
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 1,
  "Data": [
    {
      "Id": 10001,
      "Name": "SampleEditor",
      "Version": "1.2.3",
      "VersionName": "1.2.3 Official Release",
      "SourceType": "TENANT",
      "OriginAppType": "ClientBase",
      "OsType": "WINDOWS",
      "Description": "Used for document editing",
      "DistributeType": "ALL",
      "AuthType": "auth_type_user",
      "AutoInstallmentType": 1,
      "IsAdmin": false
    }
  ]
}

This example indicates that the application is authorized to all users at the user level. AutoInstallmentType=1 indicates that automatic installation is enabled only for partially visible users.

Empty result example

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

Examples

Success response

JSON format

{
  "Code": "200",
  "Data": [
    {
      "AdminTag": [
        "Recommended"
      ],
      "AppAdminTag": "Recommended",
      "AppRegInfo": "SampleEditor",
      "AppTag": [
        "Office"
      ],
      "AppUid": "app-demo-001",
      "AuthType": "auth_type_user",
      "AutoDeleteFlag": false,
      "AutoInstallFlag": false,
      "AutoInstallType": "SILENCE_INSTALL",
      "AutoInstallmentType": 1,
      "CateId": 1001,
      "CateName": "Office",
      "ClusterUid": "cluster-demo-001",
      "Description": "Used for document editing",
      "Developer": "Sample Software Company",
      "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": false,
      "IconUrl": "https://example.com/icons/editor.png",
      "IconUrlInternal": "https://example.com/icons/editor.png",
      "Id": 10001,
      "Install": false,
      "InstallMode": 0,
      "IsAdmin": false,
      "IsFree": "TRUE",
      "IsGame": false,
      "IsWhiteList": 0,
      "ItemCode": "app-demo-001",
      "Labels": "Office",
      "LicenseType": "MANUAL",
      "ManageCateEnName": "Office",
      "ManageCateId": 1001,
      "ManageCateName": "Office",
      "Name": "SampleEditor",
      "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": "Edit Document",
      "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": [
        "Recommended"
      ],
      "Version": "1.2.3",
      "VersionName": "1.2.3 Release",
      "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
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.