All Products
Search

This Product

    Elastic Desktop Service:CreateEcdReportTask

    Document Center

    Elastic Desktop Service:CreateEcdReportTask

    Last Updated:Apr 02, 2026

    Creates a data report export task.

    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:CreateEcdReportTask

    none

    *All Resource

    *

    None

    None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    TaskType

    string

    Yes

    The type of the report task.

    Valid value:

    • RESOURCE_REPORT

    Valid values:

    • RESOURCE_REPORT :

    RESOURCE_REPORT

    SubType

    string

    Yes

    The sub-type of the report export task.

    Valid values:

    • DESKTOP :

      Cloud computer

    DESKTOP

    FilterList

    array<object>

    No

    The filter conditions for filtering query results. The logical relationship between each filter condition is "and" (&). Each filter condition contains FilterKey and FilterValues, which indicate the key and value for the filter condition.

    object

    No

    The filter condition object.

    FilterKey

    string

    No

    The key of the filter condition for filtering query results. When SubType is set to:

    1. DESKTOP (indicating a cloud computer report), the following filter conditions are available:

    • KeyWord: cloud computer keyword (supports automatic recognition)

    • RegionId: region ID

    • DesktopId: cloud computer ID

    • DesktopName: cloud computer name (supports fuzzy matching)

    • OfficeSiteId: office network ID

    • OfficeSiteName: office network name (supports fuzzy matching)

    • Status: cloud computer status

    • DesktopType: desktop type

    • DesktopIP: cloud computer IP address

    • SubPayType: billing method

    • EndUserId: user name (supports fuzzy matching)

    • ExpireTime: expiration date and time, in the yyyy-MM-dd'T'HH:mm:ss'Z' format

    • IncludeAssignedUser: indicates whether the cloud computer is assigned to users or not

    • ResourceGroupId: resource group ID

    • PolicyId: policy ID

    • Tag:{Tag Key value}: cloud computer tag (To filter data using multiple tags, specify multiple filter condition objects.)

    Tag:TestKey

    FilterValues

    array

    No

    The value of the filter condition. Only the first value of the FilterValues parameter is used, if FilterKey is set to one of the following values:

    • KeyWord

    • DesktopName

    • OfficeSiteName

    • DesktopIP

    • EndUserId

    • ExpireTime

    • IncludeAssignedUser

    string

    No

    The specific value of the filter condition for filtering query results.

    测试云电脑名称

    ReportFileName

    string

    No

    The name of the report file.

    测试报表名称

    LangType

    string

    No

    The language of the report. An enumerated type.

    Valid values:

    • zh-CN :

      (Default) Chinese

    • en-GB :

      English

    zh-CN

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

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

    Success

    boolean

    Indicates whether the request is successful.

    True

    Code

    string

    The request result. If the request was successful, success is returned. If the request failed, an error message is returned.

    success

    Message

    string

    The error message returned if the request failed. This parameter is not returned if the value of Code is success.

    success

    TaskId

    string

    The ID of the report export task.

    ret-g67ip******

    Examples

    Success response

    JSON format

    {
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "Success": true,
  "Code": "success",
  "Message": "success",
  "TaskId": "ret-g67ip******"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.