Query application information with DescribeApps - Elastic Compute Service

Queries information about applications.

Operation description

Operation Description

This operation queries the tag key-value pairs of disks and snapshots that are associated with an application. You can use the filterTagKey parameter to narrow the scope of the query.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
AppNames	array	No	The list of applications to query. If this parameter is left empty, information about all applications is returned.	App1,App2
	string	No	The name of the application.	default
RegionId	string	No	The ID of the region. To query the regions that support EBS Lens, call DescribeRegions.	cn-shanghai
Owner	string	No	The ID of the user.	1485558146415628
ClientToken	string	No	A string that the server generates to identify a client request.	123e4567-e89b-12d3-a456-42665544****
AppIds	array	No	The IDs of the applications to manage. This is a JSON array that contains up to 100 application IDs, separated by commas (,).
	string	No	The IDs of the applications to manage. This is a JSON array that contains up to 100 application IDs, separated by commas (,).	app-25603551

Response elements

Element	Type	Description	Example
	object	DescribeAppsResponse
AppInfos	array<object>	The information about the applications.
	array<object>	The details of the application.
AppName	string	This parameter is optional. It takes effect only when ReportType is set to present.	app1
AppTags	array<object>	The tags of the application.	default
	object
TagKey	string	The tag key.	ebs
TagValue	string	The tag value.	test
SubscribeStatus	string	The subscription status. Valid values: Subscribe UnSubscribe	Subscribe
SubscribePeriod	string	The report subscription period.	Weekly
Description	string	A description of the event.	这个app用于统计云盘全网用量
ReportSendEnabled	boolean	A flag that indicates whether reports are sent.	true
SlsSendEnabled	boolean	A flag that indicates whether data is delivered to SLS.
EventBridgeSendEnabled	boolean	A flag that indicates whether events are delivered to EventBridge.
MonitorSendEnabled	boolean	A flag that indicates whether data is delivered to Monitor.
ModifyTime	integer	The time when the application was last modified. The time is 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 that is used to replace the %s placeholder in the ErrMessage parameter.	-
AccessDeniedDetail	string	The detailed reason for 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.