DescribeApps によるアプリケーション情報のクエリ - ECS - Alibaba Cloud - Elastic Compute Service

集中ロール: アプリケーション情報のフォーマットを照会します。

操作説明

API の説明

ユーザー定義アプリケーションに含まれるクラウドディスクとスナップショットのタグキーと値のペアを照会します。filterTagKey を使用してクエリ範囲を絞り込むことができます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ebs:DescribeApps

list

*全部资源

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AppNames	array	任意	クエリするアプリケーションのリスト。空の場合、すべてのアプリケーション情報がクエリされます。フォーマット済み JSON 配列です。	App1,App2
	string	任意	アプリケーション名。	default
RegionId	string	任意	リージョン ID。 DescribeRegions を呼び出して、EBS Data Insights がサポートするリージョンのリストをクエリできます。	cn-shanghai
Owner	string	任意	ユーザー UID。	1485558146415628
ClientToken	string	任意	クライアントリクエストの識別子としてサーバーが生成した文字列。	123e4567-e89b-12d3-a456-42665544****
AppIds	array	任意	操作対象のアプリケーションの ID。最大 100 個の AppId をサポートするフォーマット済み JSON 配列で、コンマ (,) で区切ります。
	string	任意	操作対象のアプリケーションの ID。最大 100 個の AppId をサポートするフォーマット済み JSON 配列で、コンマ (,) で区切ります。	app-25603551

レスポンスフィールド

フィールド	型	説明	例
	object	DescribeAppsResponse。
AppInfos	array<object>	アプリケーション情報。フォーマット済み JSON 配列です。
	array<object>	アプリケーションの詳細情報。フォーマット済み JSON オブジェクトです。
AppName	string	オプション値。AppName は ReportType が present にセットされている場合にのみ効果があります。	app1
AppTags	array<object>	ユーザーアプリケーションに含まれるタグ。	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

例

成功レスポンス

JSONJSON

{
  "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"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
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.	日文说明
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.
403	NoPermission.SLR	The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.
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.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。