调用DescribeApps查询App包含的云盘和快照的标签信息-云服务器 ECS-阿里云

中心化角色：查询App信息

接口说明

查询用户定义的 App 所包含的云盘和快照的标签键值，可通过 filterTagKey 缩小查询范围。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
AppNames	array	否	要查询的 App 列表，空值则查询所有 App 信息	App1,App2
	string	否	应用名。	default
RegionId	string	否	地域 ID。您可以调用 DescribeRegions 查询块存储数据洞察支持的地域列表。	cn-shanghai
Owner	string	否	用户 Uid	1485558146415628
ClientToken	string	否	服务端生成的一串字符串，作为客户端进行请求的一个标识。	123e4567-e89b-12d3-a456-42665544****
AppIds	array	否	指定要操作的 app 编号，一个带有格式的 JSON 数组，最多支持 100 个 AppId，用半角逗号（,）隔开。
	string	否	指定要操作的 app 编号，一个带有格式的 JSON 数组，最多支持 100 个 AppId，用半角逗号（,）隔开。	app-25603551

返回参数

名称	类型	描述	示例值
	object	DescribeAppsResponse
AppInfos	array<object>	App 信息。
	array<object>	应用的详细信息。
AppName	string	可选值，只在 ReportType=present 时 AppName 才会生效	app1
AppTags	array<object>	用户 App 所包含的标签	default
	object
TagKey	string	标签键。	ebs
TagValue	string	标签值。	test
SubscribeStatus	string	订阅状态。取值： Subscribe：订阅 UnSubscribe：未订阅	Subscribe
SubscribePeriod	string	报告订阅周期。	Weekly
Description	string	事件描述。	这个app用于统计云盘全网用量
ReportSendEnabled	boolean	是否发送报告标志位	true
SlsSendEnabled	boolean	是否投递 Sls 标志位
EventBridgeSendEnabled	boolean	是否投递 EventBridge 标志位
MonitorSendEnabled	boolean	是否投递 Monitor 标志位
ModifyTime	integer	修改时间（UTC 时间）	2025-11-14T02:11:32Z
Default	boolean	默认时区。	true
AppId	string	应用 ID。	app-bd5e3533
RequestId	string	请求 ID。	A1C00637-AC84-5EFD-89B5-D5CE39F0F2B1
Code	string	内部错误码。	OK
UserCode	string	用户错误码	OK
Message	string	消息。	success
Success	boolean	请求成功与否标识。	True
HttpStatusCode	integer	HTTP 状态码	200
DynamicCode	string	动态错误码	OK
DynamicMessage	string	动态错误信息，用于替换返回参数 ErrMessage 错误信息中的%s。	-
AccessDeniedDetail	string	访问被拒绝的详细原因。	None

示例

正常返回示例

JSON格式

{
  "AppInfos": [
    {
      "AppName": "app1",
      "AppTags": [
        {
          "TagKey": "ebs",
          "TagValue": "test"
        }
      ],
      "SubscribeStatus": "Subscribe",
      "SubscribePeriod": "Weekly",
      "Description": "这个app用于统计云盘全网用量",
      "ReportSendEnabled": true,
      "SlsSendEnabled": true,
      "EventBridgeSendEnabled": true,
      "MonitorSendEnabled": true,
      "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"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	The parameter %s 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.	返回值格式不正确（Format 不支持）。返回格式支持 XML 与 JSON，默认为 XML。
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.	参数缺失。
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	内部错误。
403	Forbidden	User is not authorized to operate.	当前用户无权限对当前资源执行任何操作。请检查您的账号权限或者咨询您的主账号管理员。
403	Forbidden.Action	User is not authorized to operate this action.	当前用户无权限执行该操作。请检查您的账号权限或者咨询您的主账号管理员。
403	InvalidAccountStatus.NotEnoughBalance	Your account does not have enough balance.	您的账户余额不足。
403	LastTokenProcessing	The last token request is processing.	相同clientToken的请求正在执行，请稍后再重试。
403	NoPermission.SLR	The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.	当前用户无权限创建SLR。
403	OperationDenied	The operation is not allowed.	当前操作不允许执行。
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	NoSuchResource	The specified resource does not exist.	指定的资源不存在。
504	RequestTimeout	The request is timeout, please try again later.	该请求超时，请稍后再重试。
429	BLOCK.LimitedRequest	Request was denied due to user flow control.

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

变更历史

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