GetMmsJob - MaxCompute - Alibaba Cloud Documentation Center

Retrieves the details of a specific MaxCompute Migration Assist (MMA) migration plan.

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:GetMmsJob

get

*project

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

None

Request syntax

GET /api/v1/mms/datasources/{sourceId}/jobs/{jobId} HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
sourceId	integer	Yes	The data source ID.	2000015
jobId	integer	Yes	The job ID.	10

Response elements

Element	Type	Description	Example
	object	ApiRes
requestId	string	The request ID.	D9F872FD-5DDE-30A6-8C8A-1B8C6A81059F
data	object	The migration job object.
id	integer	The migration job ID.	10
name	string	The name of the migration job.	migrate_db_1
sourceId	integer	The data source ID.	2
dbId	integer	The source database ID.	23
sourceName	string	The name of the data source.	demo
srcDbName	string	The name of the source database.	mms_test
srcSchemaName	string	The name of the source schema. This parameter specifies the schema in a Layer 3 namespace.	default
dstDbName	string	The destination MaxCompute project.	mms_target
dstSchemaName	string	The destination MaxCompute schema.	default
status	string	The status of the migration task. Valid values: INIT : 未运行 DONE : 成功 DOING : 运行中 FAILED : 运行失败	DOING
type	string	The migration scope. Valid values: Database, Tables, and Partitions. Valid values: Partitions : 多分区 Database : 单库 Tables : 多表	Tables
taskNum	integer	The number of migration tasks that are included.	100
stopped	boolean	Indicates whether the job is stopped.	false
createTime	string	The time when the job was created.	2024-12-17 15:44:17
taskDone	integer	The number of completed migration tasks.	100
config	object
partitions	array
	integer
tables	array
	string
taskType	string	MOCK, HIVE: a Hive user-defined table-valued function (UDTF) task, HIVE_DATAX: a Hive DataX task, COPY_TASK: an ODPS Copy Task, ODPS_INSERT_OVERWRITE: an ODPS simple insert overwrite task, MC2MC_VERIFY, OSS, HIVE_OSS, HIVE_SPARK, or BIGQUERY
tableBlackList	array
	string
tableWhiteList	array
	string
partitionFilters	object
	string
schemaOnly	boolean
tableMapping	object
	string
increment	boolean
enableVerification	boolean
tunnelQuota	string
columnMapping	object
	string
others	object
eta	string

Examples

Success response

JSON format

{
  "requestId": "D9F872FD-5DDE-30A6-8C8A-1B8C6A81059F",
  "data": {
    "id": 10,
    "name": "migrate_db_1",
    "sourceId": 2,
    "dbId": 23,
    "sourceName": "demo",
    "srcDbName": "mms_test",
    "srcSchemaName": "default",
    "dstDbName": "mms_target",
    "dstSchemaName": "default",
    "status": "DOING",
    "type": "Tables",
    "taskNum": 100,
    "stopped": true,
    "createTime": "2024-12-17 15:44:17",
    "taskDone": 100,
    "config": {
      "partitions": [
        0
      ],
      "tables": [
        ""
      ],
      "taskType": "",
      "tableBlackList": [
        ""
      ],
      "tableWhiteList": [
        ""
      ],
      "partitionFilters": {
        "key": ""
      },
      "schemaOnly": true,
      "tableMapping": {
        "key": ""
      },
      "increment": true,
      "enableVerification": true,
      "tunnelQuota": "",
      "columnMapping": {
        "key": ""
      },
      "others": {
        "test": "test",
        "test2": 1
      }
    },
    "eta": ""
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.