DescribeEcdReportTasks-阿里云帮助中心

Retrieves a list of report export tasks.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecd:DescribeEcdReportTasks

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TaskId	string	No	The ID of the report task.	ret-sfkdsjfi*****
TaskType	string	No	The type of the report. Valid values: RESOURCE_REPORT : Resource report	RESOURCE_REPORT
SubType	string	No	The subtype of the report task. Valid values: DESKTOP : Elastic Cloud Desktop	DESKTOP
Status	array	No	The status of the report task. You can specify one or more statuses. Valid values: INIT : The task is being initialized. FAILED : The task failed. RUNNING : The task is running. EXPIRED : The task has expired. FINISHED : The task is complete.
	string	No	The status of the task.	RUNNING
PageNum	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 20.	20。

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TotalCount	integer	The total number of entries returned.	20
ExportTaskList	array<object>	The list of report tasks.
	object
TaskId	string	The ID of the report task.	ret-asdfkjg*****
TaskType	string	The type of the report. Valid values: RESOURCE_REPORT : Resource report	RESOURCE_REPORT
SubType	string	The subtype of the report task. Valid values: DESKTOP : Elastic Cloud Desktop	DESKTOP
ReportFileName	string	The name of the report file.	TestFileName
Status	string	The status of the report task.	Running
Progress	number	The progress of the report export task, as a percentage.	80
GmtCreate	string	The creation time.	2025-07-14T07:46:49.000+00:00
GmtModified	string	The modification time.	2025-07-14T07:46:49.000+00:00
DownloadUrl	string	The download URL for the report file.	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	The error code.	Success
ErrorMsg	string	The error message.	No Data.

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.