All Products
Search

This Product

    DataWorks:CreateExportMigration

    Document Center

    DataWorks:CreateExportMigration

    Last Updated:Jul 31, 2026

    Creates an export task in DataWorks. This API operation only creates the export task and does not start the 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

    dataworks:*

    none

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ProjectId

    integer

    Yes

    The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace configuration page to obtain the workspace ID.

    12345
    Name

    string

    Yes

    The name of the export task.

    The name must be unique. No duplicate export task names can exist in the current DataWorks workspace.

    test_export_01
    ExportMode

    string

    Yes

    The export mode of the task. Valid values:

    • FULL: exports the target task in full.

    • INCREMENTAL: incrementally exports the target task from a specified point in time. If you select this mode, you must also configure the IncrementalSince parameter.

    Valid values:

    • FULL :

      full export.

    • INCREMENTAL :

      incremental export.

    FULL
    IncrementalSince

    integer

    No

    The start time for incrementally exporting the target node.

    This parameter takes effect only when the ExportMode parameter settings is set to INCREMENTAL.

    1589904000000
    ExportObjectStatus

    string

    No

    The status of the export task. The system exports tasks in the specified status. Valid values:

    • SAVED: saved. Tasks that have been saved are exported.

    • SUBMITTED: submitted. Tasks that have been submitted are exported.

    • DEPLOYED: deployed. Tasks that have been deployed are exported.

    Valid values:

    • DEPLOYED :

      Deployed. Tasks that have been deployed are exported.

    • SAVED :

      Saved. Tasks that have been saved are exported.

    • SUBMITTED :

      Submitted. Tasks that have been submitted are exported.

    SAVED
    Description

    string

    No

    The description of the export task.

    test

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID. You can use the ID to locate logs and troubleshoot issues.

    34267E2E-0335-1A60-A1F0-ADA530890CBA
    Data

    integer

    The ID of the export task.

    1234
    Success

    boolean

    Indicates whether the call was successful. Valid values:

    • true: The call was successful.

    • false: The call failed. You can locate the issue based on the request ID.

    true

    Examples

    Success response

    JSON format

    {
  "RequestId": "34267E2E-0335-1A60-A1F0-ADA530890CBA",
  "Data": 1234,
  "Success": true
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.