All Products
Search
Document Center

Data Online Migration:CreateJob

Last Updated:Jun 16, 2025

Creates a migration task.

Operation description

  • To create a migration task, you must have the permission on mgw:CreateImportJob.
  • Before you create a migration task, you must create data addresses.
  • A migration task can run multiple rounds. Each round has an execution ID.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

POST /job HTTP/1.1 Host: userid.cn-hangzhou.mgw.aliyuncs.com <?xml version="1.0" encoding="UTF-8"?> <ImportJob> <Name>string</Name> <SrcAddress>string</SrcAddress> <DestAddress>string</DestAddress> <OverwriteMode>string</OverwriteMode> <TransferMode>string</TransferMode> <Tags>string</Tags> <ParentVersion>string</ParentVersion> <ConvertSymlinkTarget>boolean</ConvertSymlinkTarget> <Audit> <LogMode>string</LogMode> </Audit> <EnableMultiVersioning>boolean</EnableMultiVersioning> <FilterRule> <KeyFilters> <Includes> <Regex>string</Regex> </Includes> <Excludes> <Regex>string</Regex> </Excludes> </KeyFilters> <LastModifiedFilters> <Includes> <TimeFilter> <StartTime>string</StartTime> <EndTime>string</EndTime> </TimeFilter> </Includes> <Excludes> <TimeFilter> <StartTime>string</StartTime> <EndTime>string</EndTime> </TimeFilter> </Excludes> </LastModifiedFilters> <FileTypeFilters> <ExcludeSymlink>boolean</ExcludeSymlink> <ExcludeDir>boolean</ExcludeDir> </FileTypeFilters> </FilterRule> <ImportQos> <MaxBandWidth>integer</MaxBandWidth> <MaxImportTaskQps>integer</MaxImportTaskQps> </ImportQos> <ScheduleRule> <StartCronExpression>string</StartCronExpression> <SuspendCronExpression>string</SuspendCronExpression> <MaxScheduleCount>integer</MaxScheduleCount> </ScheduleRule> <CreateReport>boolean</CreateReport> </ImportJob>

Request parameters

ParameterTypeRequiredDescriptionExample
bodyobjectNo

The request body for creating the migration task.

ImportJobCreateJobInfoYes

The details for creating the migration task.

Response parameters

ParameterTypeDescriptionExample
The current API has no return parameters

Examples

Sample success responses

JSONformat

{}

XMLformat

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<root/>

Error codes

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