中心化角色：查詢App資訊
介面說明
介面說明
查詢使用者定義的 App 所包含的雲端硬碟和快照的標籤索引值，可通過 filterTagKey 縮小查詢範圍。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| AppNames |
array |
否 |
要查詢的 App 列表，空值則查詢所有 App 資訊 |
App1,App2 |
|
string |
否 |
應用程式名稱。 |
default |
|
| RegionId |
string |
否 |
地區 ID。您可以調用 DescribeRegions 查詢Block Storage資料洞察支援的地區列表。 |
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 |
| 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. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。