DescribeEcdReportTasks でレポートエクスポートタスクのステータスを照会 - Elastic Desktop Service - Alibaba Cloud - Elastic Desktop Service

レポートエクスポートタスクの一覧を取得します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecd:DescribeEcdReportTasks

none

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TaskId	string	任意	レポートタスクの ID です。	ret-sfkdsjfi*****
TaskType	string	任意	レポートの種類です。列挙値: RESOURCE_REPORT : リソースレポート	RESOURCE_REPORT
SubType	string	任意	レポートタスクのサブタイプです。列挙値: DESKTOP : Elastic Cloud Desktop	DESKTOP
Status	array	任意	レポートタスクのステータスです。1 つ以上のステータスを指定できます。列挙値: INIT : タスクが初期化中です。 FAILED : タスクが失敗しました。 RUNNING : タスクが実行中です。 EXPIRED : タスクの有効期限が切れました。 FINISHED : タスクが完了しました。
	string	任意	タスクのステータスです。	RUNNING
PageNum	integer	任意	ページ番号です。デフォルト値は 1 です。	1
PageSize	integer	任意	1 ページあたりの表示件数です。デフォルト値は 20 です。	20。

レスポンスフィールド

フィールド	型	説明	例
	object	応答オブジェクトです。
RequestId	string	リクエスト ID です。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TotalCount	integer	返された合計件数です。	20
ExportTaskList	array<object>	レポートタスクの一覧です。
	object
TaskId	string	レポートタスクの ID です。	ret-asdfkjg*****
TaskType	string	レポートの種類です。列挙値: RESOURCE_REPORT : リソースレポート	RESOURCE_REPORT
SubType	string	レポートタスクのサブタイプです。列挙値: DESKTOP : Elastic Cloud Desktop	DESKTOP
ReportFileName	string	レポートファイルの名前です。	TestFileName
Status	string	レポートタスクのステータスです。	Running
Progress	number	レポートエクスポートタスクの進捗率（パーセント）です。	80
GmtCreate	string	作成時刻です。	2025-07-14T07:46:49.000+00:00
GmtModified	string	更新時刻です。	2025-07-14T07:46:49.000+00:00
DownloadUrl	string	レポートファイルのダウンロード URL です。	https://cn-shanghai-ecd-report-files.oss-cn-shanghai.aliyuncs.com/ecd_report/resource/desktop/100721430***/DESKTOP_20250709140932_*.xlsx?Expires=*&OSSAccessKeyId=STS.&Signature=%3D&security-token=**
ErrorCode	string	エラーコードです。	Success
ErrorMsg	string	エラーメッセージです。	No Data.

例

成功レスポンス

JSONJSON

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "TotalCount": 20,
  "ExportTaskList": [
    {
      "TaskId": "ret-asdfkjg*****",
      "TaskType": "RESOURCE_REPORT",
      "SubType": "DESKTOP",
      "ReportFileName": "TestFileName",
      "Status": "Running",
      "Progress": 80,
      "GmtCreate": "2025-07-14T07:46:49.000+00:00",
      "GmtModified": "2025-07-14T07:46:49.000+00:00",
      "DownloadUrl": "https://cn-shanghai-ecd-report-files.oss-cn-shanghai.aliyuncs.com/ecd_report/resource/desktop/100721430*****/DESKTOP_20250709140932_*****.xlsx?Expires=*****&OSSAccessKeyId=STS.****&Signature=****%3D&security-token=****",
      "ErrorCode": "Success",
      "ErrorMsg": "No Data."
    }
  ]
}

エラーコード

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

変更履歴

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