All Products
Search
Document Center

DataWorks:CreateExportMigration

Last Updated:Sep 04, 2025

Creates an export task. You can use this operation to create an export task but cannot use this operation to start the created export task.

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
dataworks:*none
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectIdlongYes

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

12345
NamestringYes

The name of the export task.

The name of each export task must be unique. You must ensure that no duplicate export task exists in the current workspace.

test_export_01
ExportModestringYes

The export mode of the export task. Valid values:

  • FULL: The export task is used to export all data objects.
  • INCREMENTAL: The export task is used to export data objects that were modified since the specified point in time. If you set this parameter to INCREMENTAL, you must configure the IncrementalSince parameter.
FULL
IncrementalSincelongNo

The start time of the incremental export task.

The IncrementalSince parameter takes effect only when the ExportMode parameter is set to INCREMENTAL.

1589904000000
ExportObjectStatusstringNo

The status of the data objects that you want to export in the export task. The system exports data objects in the state that is specified by this parameter. Valid values:

  • SAVED
  • SUBMITTED
  • DEPLOYED
SAVED
DescriptionstringNo

The description of the export task.

test

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

RequestIdstring

The request ID. You can locate logs and troubleshoot issues based on the ID.

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

The export task ID.

1234
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history