All Products
Search
Document Center

Elastic Desktop Service:DescribeEcdReportTasks

Last Updated:Nov 03, 2025

Queries data report export tasks.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ecd:DescribeEcdReportTasksnone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TaskIdstringNo

The ID of the report export task.

ret-sfkdsjfi*****
TaskTypestringNo

The type of the report.

Valid value:

  • RESOURCE_REPORT
RESOURCE_REPORT
SubTypestringNo

The sub-type of the report export task.

Valid value:

  • DESKTOP: cloud computer
DESKTOP
StatusarrayNo

The task status.

Valid values:

  • INIT: initializing
  • FAILED
  • RUNNING
  • EXPIRED
  • FINISHED
stringNo

The task status.

RUNNING
PageNumintegerNo

The number of the page to return. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries returned per page. Maximum value: 200.

20。

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TotalCountlong

The total number of entries returned.

20
ExportTaskListarray<object>

The report export tasks.

exportTaskobject
TaskIdstring

The ID of the report export task.

ret-asdfkjg*****
TaskTypestring

The type of the report.

Valid value:

  • RESOURCE_REPORT
RESOURCE_REPORT
SubTypestring

The sub-type of the report export task.

Valid value:

  • DESKTOP: cloud computer
DESKTOP
ReportFileNamestring

The name of the report file.

TestFileName
Statusstring

The task status.

Running
Progressfloat

The progress of the report export task. Unit: %.

80
GmtCreatestring

The time when the task was created.

2025-07-14T07:46:49.000+00:00
GmtModifiedstring

The time when the task was last modified.

2025-07-14T07:46:49.000+00:00
DownloadUrlstring

The download URL of 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=****
ErrorCodestring

The error code returned.

Success
ErrorMsgstring

The error message.

No Data.

Examples

Sample success responses

JSONformat

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

For a list of error codes, visit the Service error codes.