All Products
Search

This Product

    MaxCompute:ListMmsTasks

    Document Center

    MaxCompute:ListMmsTasks

    Last Updated:Jun 29, 2026

    Retrieves a list of data migration tasks.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    odps:ListMmsTasks

    list

    *project

    acs:odps:{#regionId}:{#accountId}:mmsdatasource/{#sourceId}

    		 None None

    Request syntax

    GET /api/v1/mms/datasources/{sourceId}/tasks HTTP/1.1

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    sourceId

    integer

    Yes

    The data source ID.

    2000028

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    jobId

    integer

    No

    The migration job ID.

    10
    jobName

    string

    No

    The job name.

    test1
    srcDbName

    string

    No

    The source database name.

    test_db_1
    srcTableName

    string

    No

    The source table name.

    test_table_1
    dstDbName

    string

    No

    The destination MaxCompute project.

    mms_test
    dstTableName

    string

    No

    The destination MaxCompute table.

    test_table_1
    status

    string

    No

    The migration task status.

    Valid values:

    • INIT :

      not executed.

    • DONE :

      succeeded.

    • VERIFICATION_FAILED :

      data validation failed.

    • SCHEMA_DONE :

      schema migration succeeded.

    • SCHEMA_DOING :

      schema migration in progress.

    • VERIFICATION_DOING :

      data validation in progress.

    • SCHEMA_FAILED :

      schema migration failed.

    • VERIFICATION_DONE :

      data validation succeeded.

    • DATA_DOING :

      data migration in progress.

    • DATA_DONE :

      data migration succeeded.

    • DATA_FAILED :

      data migration failed.

    DATA_DOING
    partition

    string

    No

    The partition value. Use this parameter to filter migration tasks that migrated a specific partition value.

    p1=1/p2=abc
    pageNum

    integer

    No

    The page number.

    1
    pageSize

    integer

    No

    The page size.

    10
    sorter.startTime

    string

    No

    Sorts results by the start time.

    Valid values:

    • asc :

      ascending order.

    • desc :

      descending order.

    desc
    sorter.status

    string

    No

    Sorts results by status.

    Valid values:

    • asc :

      ascending order.

    • desc :

      descending order.

    asc

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    requestId

    string

    The request ID.

    373A5CB2-8570-53BE-A98F-729B11D7A8B0
    data

    object

    The returned data.

    total

    integer

    The total number of records.

    100
    objectList

    array<object>

    The list of migration tasks.

    object

    The migration task object.

    id

    integer

    The migration task ID.

    2323
    jobId

    integer

    The migration job ID.

    87
    sourceId

    integer

    The data source ID.

    2000028
    dbId

    integer

    The source database ID.

    196
    tableId

    integer

    The source table ID.

    23
    jobName

    string

    The migration job name.

    test_odps_spark
    sourceName

    string

    The data source name.

    demo

    srcDbName

    string

    The source database name.

    db_1
    srcSchemaName

    string

    The source schema name in a three-level namespace.

    default
    srcTableName

    string

    The source table name.

    table_1
    dstDbName

    string

    The destination MaxCompute project.

    mms_test
    dstSchemaName

    string

    The destination MaxCompute schema.

    default
    dstTableName

    string

    The destination MaxCompute table.

    table_1
    type

    string

    The task type.

    Valid values:

    • HIVE :

      migration through Hive UDTF.

    • BIGQUERY :

      migration through Read API.

    BIGQUERY
    status

    string

    The migration task status.

    Valid values:

    • INIT :

      not running.

    • DONE :

      succeeded.

    • SCHEMA_DONE :

      schema migration succeeded.

    • SCHEMA_DOING :

      schema migration in progress.

    • SCHEMA_FAILED :

      schema migration failed.

    • DATA_DOING :

      data migration in progress.

    • DATA_DONE :

      data migration succeeded.

    • DATA_FAILED :

      data migration failed.

    DATA_DOING
    running

    boolean

    Indicates whether the task is running.

    true
    stopped

    boolean

    Indicates whether the task is stopped.

    false
    retriedTimes

    integer

    The number of retries that have been performed.

    1
    startTime

    string

    The start time of the task.

    2024-10-25 06:21:01
    endTime

    string

    The end time of the task.

    2024-10-25 07:21:01

    createTime

    string

    The time when the task was created.

    2024-10-25 04:21:01

    pageNum

    integer

    The page number.

    1
    pageSize

    integer

    The page size.

    10

    Examples

    Success response

    JSON format

    {
  "requestId": "373A5CB2-8570-53BE-A98F-729B11D7A8B0",
  "data": {
    "total": 100,
    "objectList": [
      {
        "id": 2323,
        "jobId": 87,
        "sourceId": 2000028,
        "dbId": 196,
        "tableId": 23,
        "jobName": "test_odps_spark",
        "sourceName": "demo ",
        "srcDbName": "db_1",
        "srcSchemaName": "default",
        "srcTableName": "table_1",
        "dstDbName": "mms_test",
        "dstSchemaName": "default",
        "dstTableName": "table_1",
        "type": "BIGQUERY",
        "status": "DATA_DOING",
        "running": true,
        "stopped": false,
        "retriedTimes": 1,
        "startTime": "2024-10-25 06:21:01",
        "endTime": "2024-10-25 07:21:01\n",
        "createTime": "2024-10-25 04:21:01\n"
      }
    ],
    "pageNum": 1,
    "pageSize": 10
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.