All Products
Search
Document Center

Data Online Migration:ListJob

Last Updated:Jun 16, 2025

Lists the migration tasks created by a user in the specific region.

Operation description

  • To query a list of migration tasks, you must have the permission on mgw:ListImportJob.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /joblist HTTP/1.1 Host: userid.cn-hangzhou.mgw.aliyuncs.com

Request parameters

ParameterTypeRequiredDescriptionExample
markerstringNo

The marker after which the migration tasks are listed.
By default, this parameter is left empty.

test_marker
countstringNo

Specifies the number of migration tasks to be returned.
Valid values: 0 - 1000 (excluding 0).
Default value: 1000.

1000
parentNamestringNo

The name of the parent task. If this parameter is specified, all subtasks of the parent task are returned.

test_parent_job_name
allstringNo

Specifies whether to return subtasks.
Valid values: true and false.

true

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

ImportJobListListJobResp

The queried migration tasks.

Examples

Sample success responses

JSONformat

{
  "ImportJobList": {
    "NextMarker": "test_nex_marker",
    "Truncated": true,
    "ImportJob": [
      {
        "Name": "test_name",
        "SrcAddress": "test_src_address",
        "DestAddress": "test_dest_address",
        "Status": "IMPORT_JOB_DOING",
        "EnableMultiVersioning": false,
        "CreateTime": "2024-05-01 12:00:00",
        "ModifyTime": "2024-05-01 12:00:00",
        "Version": "test_id",
        "Audit": {
          "LogMode": "off"
        },
        "OverwriteMode": "always",
        "TransferMode": "all",
        "Tags": "K1:V1,K2:V2",
        "ParentName": "test_parent_name",
        "ParentVersion": "7db93837-a5ee-4e3a-b3c8-800e7947dabc",
        "ConvertSymlinkTarget": false,
        "CreateReport": false,
        "Owner": "test_owner",
        "FilterRule": {
          "KeyFilters": {
            "Includes": {
              "Regex": [
                ".*\\.jpg$"
              ]
            },
            "Excludes": {
              "Regex": [
                ".*\\.jpg$"
              ]
            }
          },
          "LastModifiedFilters": {
            "Includes": {
              "TimeFilter": [
                {
                  "StartTime": "2006-01-01T00:00:00Z",
                  "EndTime": "2006-12-31T59:59:59Z"
                }
              ]
            },
            "Excludes": {
              "TimeFilter": [
                {
                  "StartTime": "2006-01-01T00:00:00Z",
                  "EndTime": "2006-12-31T59:59:59Z"
                }
              ]
            }
          },
          "FileTypeFilters": {
            "ExcludeSymlink": true,
            "ExcludeDir": true
          }
        },
        "ImportQos": {
          "MaxBandWidth": 1073741824,
          "MaxImportTaskQps": 1000
        },
        "ScheduleRule": {
          "StartCronExpression": "0 0 * * * ?",
          "SuspendCronExpression": "0 0 * * * ?",
          "MaxScheduleCount": 1
        }
      }
    ]
  }
}

XMLformat

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ImportJobList>
  <NextMarker>test_nex_marker</NextMarker>
  <Truncated>true</Truncated>
  <ImportJob>
    <Name>test_name</Name>
    <SrcAddress>test_src_address</SrcAddress>
    <DestAddress>test_dest_address</DestAddress>
    <Status>IMPORT_JOB_DOING</Status>
    <EnableMultiVersioning>false</EnableMultiVersioning>
    <CreateTime>2024-05-01 12:00:00</CreateTime>
    <ModifyTime>2024-05-01 12:00:00</ModifyTime>
    <Version>test_id</Version>
    <Audit>
      <LogMode>off</LogMode>
    </Audit>
    <OverwriteMode>always</OverwriteMode>
    <TransferMode>all</TransferMode>
    <Tags>K1:V1,K2:V2</Tags>
    <ParentName>test_parent_name</ParentName>
    <ParentVersion>7db93837-a5ee-4e3a-b3c8-800e7947dabc</ParentVersion>
    <ConvertSymlinkTarget>false</ConvertSymlinkTarget>
    <CreateReport>false</CreateReport>
    <Owner>test_owner</Owner>
    <FilterRule>
      <KeyFilters>
        <Includes>
          <Regex>.*\.jpg$</Regex>
        </Includes>
        <Excludes>
          <Regex>.*\.jpg$</Regex>
        </Excludes>
      </KeyFilters>
      <LastModifiedFilters>
        <Includes>
          <TimeFilter>
            <StartTime>2006-01-01T00:00:00Z</StartTime>
            <EndTime>2006-12-31T59:59:59Z</EndTime>
          </TimeFilter>
        </Includes>
        <Excludes>
          <TimeFilter>
            <StartTime>2006-01-01T00:00:00Z</StartTime>
            <EndTime>2006-12-31T59:59:59Z</EndTime>
          </TimeFilter>
        </Excludes>
      </LastModifiedFilters>
      <FileTypeFilters>
        <ExcludeSymlink>true</ExcludeSymlink>
        <ExcludeDir>true</ExcludeDir>
      </FileTypeFilters>
    </FilterRule>
    <ImportQos>
      <MaxBandWidth>1073741824</MaxBandWidth>
      <MaxImportTaskQps>1000</MaxImportTaskQps>
    </ImportQos>
    <ScheduleRule>
      <StartCronExpression>0 0 * * * ?</StartCronExpression>
      <SuspendCronExpression>0 0 * * * ?</SuspendCronExpression>
      <MaxScheduleCount>1</MaxScheduleCount>
    </ScheduleRule>
  </ImportJob>
</ImportJobList>

Error codes

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