All Products
Search
Document Center

:CreateExportMigration

最終更新日:May 13, 2024

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action

String

Yes

CreateExportMigration

The operation that you want to perform.

ProjectId

Long

Yes

12345

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

Name

String

Yes

test_export_01

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.

ExportMode

String

Yes

FULL

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.

IncrementalSince

Long

No

1589904000000

The start time of the incremental export task.

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

ExportObjectStatus

String

No

SAVED

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

Description

String

No

test

The description of the export task.

Response parameters

Parameter

Type

Example

Description

RequestId

String

34267E2E-0335-1A60-A1F0-ADA530890CBA

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

Data

Long

1234

The export task ID.

Success

Boolean

true

Indicates whether the request was successful. Valid values:

  • true: The request was successful.

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

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateExportMigration
&ProjectId=12345
&Name=test_export_01
&ExportMode=FULL
&IncrementalSince=1589904000000
&ExportObjectStatus=SAVED
&Description=test
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateExportMigrationResponse>
    <RequestId>34267E2E-0335-1A60-A1F0-ADA530890CBA</RequestId>
    <Data>1234</Data>
    <Success>true</Success>
</CreateExportMigrationResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, see Service error codes.