Queries migration tasks.

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

ParameterTypeRequiredExampleDescription
ActionStringYesListMigrations

The operation that you want to perform. Set the value to ListMigrations.

ProjectIdLongYes12345

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

MigrationTypeStringYesIMPORT

The migration task type. Valid values: IMPORT and EXPORT.

OwnerStringNo193379****

The owner ID.

PageNumberIntegerNo1

The page number. Default value: 1. Maximum value: 100.

PageSizeIntegerNo10

The number of entries per page. Default value: 10. Maximum value: 100.

Response parameters

ParameterTypeExampleDescription
RequestIdStringF9198AA3-9010-53D5-9714-DC4461427D3E

The request ID.

SuccessBooleantrue

Indicates whether the request was successful. Valid values:

  • true
  • false
DataObject

The data returned.

MigrationsArray of Migration

The list of migration tasks.

IdLong436064

The primary key ID.

NameStringtest_task_1638498642279

The name of the migration task.

PackageTypeStringDATAWORKS_MODEL

The type of the import or export package. Valid values:

  • DWMA (standard format)
  • DATAWORKS_MODEL (standard format)
  • DATAWORKS_V2 (Apsara Stack DataWorks V3.6.1 to V3.11)
  • DATAWORKS_V3 (Apsara Stack DataWorks V3.12 and later)

The DWMA and DATAWORKS_MODEL types are interchangeable.

MigrationTypeStringEXPORT

The type of the migration task.

  • IMPORT
  • EXPORT
CreateTimeLong123124123123123

The time when the migration task was created.

UpdateTimeLong123123123123123

The time when the migration task was last updated.

CreateUserString123123****

The ID of the user who created the migration task.

CreateUserNameString3h1_test

The name of the user who created the migration task.

UpdateUserString1231****

The ID of the user who last updated the migration task.

UpdateUserNameString3h1_test

The name of the user who last updated the migration task.

ProjectIdLong72132

The ID of the DataWorks workspace to which the migration task belongs.

TenantIdLong16307

The tenant ID.

StatusStringSUCCESS

The status of the migration task. Valid values:

  • INIT: The migration task is in the initial state.
  • EDITING: The migration task is being edited.
  • RUNNING: The migration task is running.
  • FAILURE: The migration task fails to run.
  • SUCCESS: The migration task is successfully run.
MessageStringAn internal system error occurred. datasource kafka region is not cn-chengdu, can't open network for it

The error message.

DownloadUrlStringhttp://geoip-sdk-user.oss-cn-zhangjiakou.aliyuncs.com/product/v1/ipv4/trace/v1.20220424123842.dex?Expires=1650780849&OSSAccessKeyId=XXXXXXeF4Lv5j&Signature=qxxxxx

The URL that is used to download the package of the export task. You can use the URL to download the package of the export task.

DescriptionStringCreation of an automated test task

The description of the export task.

PageNumberInteger1

The page number.

PageSizeInteger10

The number of entries per page. Default value: 10. Maximum value: 50.

TotalCountInteger20

The total number of entries.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListMigrations
&ProjectId=12345
&MigrationType=IMPORT
&Owner=193379****
&PageNumber=1
&PageSize=10
&<Common request parameters>

Sample success responses

XML format

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

<ListMigrationsResponse>
    <RequestId>F9198AA3-9010-53D5-9714-DC4461427D3E</RequestId>
    <Success>true</Success>
    <Data>
        <Migrations>
            <Id>436064</Id>
            <Name>test_task_1638498642279</Name>
            <PackageType>DATAWORKS_MODEL</PackageType>
            <MigrationType>EXPORT</MigrationType>
            <CreateTime>123124123123123</CreateTime>
            <UpdateTime>123123123123123</UpdateTime>
            <CreateUser>123123****</CreateUser>
            <CreateUserName>3h1_test</CreateUserName>
            <UpdateUser>1231****</UpdateUser>
            <UpdateUserName>3h1_test</UpdateUserName>
            <ProjectId>72132</ProjectId>
            <TenantId>16307</TenantId>
            <Status>SUCCESS</Status>
            <Message>An internal system error occurred. datasource kafka region is not cn-chengdu, can't open network for it</Message>
            <DownloadUrl>http://geoip-sdk-user.oss-cn-zhangjiakou.aliyuncs.com/product/v1/ipv4/trace/v1.20220424123842.dex?Expires=1650780849&amp;OSSAccessKeyId=XXXXXXeF4Lv5j&amp;Signature=qxxxxx</DownloadUrl>
            <Description>Creation of an automated test task</Description>
        </Migrations>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>20</TotalCount>
    </Data>
</ListMigrationsResponse>

JSON format

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

{
  "RequestId" : "F9198AA3-9010-53D5-9714-DC4461427D3E",
  "Success" : true,
  "Data" : {
    "Migrations" : {
      "Id" : 436064,
      "Name" : "test_task_1638498642279",
      "PackageType" : "DATAWORKS_MODEL",
      "MigrationType" : "EXPORT",
      "CreateTime" : 123124123123123,
      "UpdateTime" : 123123123123123,
      "CreateUser" : "123123****",
      "CreateUserName" : "3h1_test",
      "UpdateUser" : "1231****",
      "UpdateUserName" : "3h1_test",
      "ProjectId" : 72132,
      "TenantId" : 16307,
      "Status" : "SUCCESS",
      "Message" : "An internal system error occurred. datasource kafka region is not cn-chengdu, can't open network for it",
      "DownloadUrl" : "http://geoip-sdk-user.oss-cn-zhangjiakou.aliyuncs.com/product/v1/ipv4/trace/v1.20220424123842.dex?Expires=1650780849&amp;OSSAccessKeyId=XXXXXXeF4Lv5j&amp;Signature=qxxxxx",
      "Description" : "Creation of an automated test task"
    },
    "PageNumber" : 1,
    "PageSize" : 10,
    "TotalCount" : 20
  }
}

Error codes

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