Query application information with DescribeApps - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries application information as a centralized role.

Operation description

Queries the tag keys and values of cloud disks and snapshots contained in a user-defined application. You can use filterTagKey to narrow the query scope.

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

ebs:DescribeApps

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppNames	array	No	The list of applications to query. If this parameter is empty, all application information is queried.	App1,App2
	string	No	The application name.	default
RegionId	string	No	The region ID. You can call DescribeRegions to query the list of regions supported by EBS Lens.	cn-shanghai
Owner	string	No	The user UID.	1485558146415628
ClientToken	string	No	A string generated by the server that serves as an identifier for the client request.	123e4567-e89b-12d3-a456-42665544****
AppIds	array	No	The IDs of the applications to query. This parameter is a formatted JSON array that supports up to 100 AppId values separated by commas (,).
	string	No	The IDs of the applications to query. This parameter is a formatted JSON array that supports up to 100 AppId values separated by commas (,).	app-25603551

Response elements

Element	Type	Description	Example
	object	DescribeAppsResponse
AppInfos	array<object>	The application information.
	array<object>	The details of the application.
AppName	string	The application name. This parameter takes effect only when ReportType is set to present.	app1
AppTags	array<object>	The tags contained in the user application.	default
	object
TagKey	string	Tag key.	ebs
TagValue	string	Tag value.	test
SubscribeStatus	string	The subscription status. Valid values: Subscribe: subscribed. UnSubscribe: not subscribed.	Subscribe
SubscribePeriod	string	The report subscription period.	Weekly
Description	string	The event description.	This app is used to collect cloud disk usage statistics across the network
ReportSendEnabled	boolean	Indicates whether report sending is enabled.	true
SlsSendEnabled	boolean	Indicates whether delivery to Simple Log Service (SLS) is enabled.
EventBridgeSendEnabled	boolean	Indicates whether delivery to EventBridge is enabled.
MonitorSendEnabled	boolean	Indicates whether delivery to CloudMonitor is enabled.
ModifyTime	integer	The modification time in UTC.	2025-11-14T02:11:32Z
Default	boolean	The default time zone.	true
AppId	string	The application ID.	app-bd5e3533
RequestId	string	The request ID.	A1C00637-AC84-5EFD-89B5-D5CE39F0F2B1
Code	string	The internal error code.	OK
UserCode	string	The user error code.	OK
Message	string	The message.	success
Success	boolean	Indicates whether the request was successful.	True
HttpStatusCode	integer	The HTTP status code.	200
DynamicCode	string	The dynamic error code.	OK
DynamicMessage	string	The dynamic error message, which is used to replace the %s variable in the ErrMessage error message.	-
AccessDeniedDetail	string	The details about the access denial.	None

Examples

Success response

JSON format

{
  "AppInfos": [
    {
      "AppName": "app1",
      "AppTags": [
        {
          "TagKey": "ebs",
          "TagValue": "test"
        }
      ],
      "SubscribeStatus": "Subscribe",
      "SubscribePeriod": "Weekly",
      "Description": "这个app用于统计云盘全网用量",
      "ReportSendEnabled": true,
      "SlsSendEnabled": false,
      "EventBridgeSendEnabled": false,
      "MonitorSendEnabled": false,
      "ModifyTime": 0,
      "Default": true,
      "AppId": "app-bd5e3533"
    }
  ],
  "RequestId": "A1C00637-AC84-5EFD-89B5-D5CE39F0F2B1",
  "Code": "OK",
  "UserCode": "OK",
  "Message": "success",
  "Success": true,
  "HttpStatusCode": 200,
  "DynamicCode": "OK",
  "DynamicMessage": "-",
  "AccessDeniedDetail": "None"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The parameter %s is invalid.	The specified parameter value is invalid.
400	InvalidParameter.Conflict	The specified parameter %s and %s are not blank at the same time.
400	InvalidParameter.Format	Specified parameter format is not valid.	english description
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.	The parameter must be specified.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error has occurred.
403	Forbidden	User is not authorized to operate.	You are not authorized to manage the resource. Check the account permissions or contact the Alibaba Cloud account.
403	Forbidden.Action	User is not authorized to operate this action.	You are not authorized to perform this operation. Check the account permissions or contact the Alibaba Cloud account.
403	InvalidAccountStatus.NotEnoughBalance	Your account does not have enough balance.
403	LastTokenProcessing	The last token request is processing.	The value of clientToken is used in another request that is being processed. Try again later.
403	NoPermission.SLR	The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.	You are not authorized to create service-linked roles.
403	OperationDenied	The operation is not allowed.	The operation is not supported.
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	NoSuchResource	The specified resource does not exist.	The specified resource does not exist.
504	RequestTimeout	The request is timeout, please try again later.	The request has timed out. Try again later.
429	BLOCK.LimitedRequest	Request was denied due to user flow control.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.