MMA Data Sources Overview via ListMmsDataSources - MaxCompute - Alibaba Cloud - MaxCompute

MaxCompute Migration Assist (MMA) data sources

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

list

*All Resource

*

None

Request syntax

GET /api/v1/mms/datasources HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
name	string	No	The name of the data source.	demo
type	string	No	The type of the data source. Valid values: HIVE : Hive BIGQUERY : BigQuery MAXCOMPUTE : MaxCompute	BIGQUERY
region	string	No	The region ID.	cn-shanghai
pageNum	integer	No	The page number.	1
pageSize	integer	No	The number of entries to return on each page.	10

Response elements

Element	Type	Description	Example
	object	The paginated data.
requestId	string	The request ID.	C1F7715F-D316-5AB6-BD02-5241083F4003
data	object	The response data.
total	integer	The total number of data sources found.	9
objectList	array<object>	The list of data sources.
	array<object>	A data source object.
id	integer	The data source ID.	2000015
region	string	The region ID.	cn-beijing
name	string	The data source name.	demo
dstProject	string	The default destination MaxCompute project.	mms_test
dstProjects	array	A list of destination MaxCompute projects.
	string	A destination MaxCompute project.	mms_test
type	string	The data source type. Valid values: HIVE : Hive BIGQUERY : BigQuery MAXCOMPUTE : MaxCompute	BIGQUERY
networklink	string	The network connection, specified in the `VpcId:regionId` format.	vpc-2zebqp6uojhdla46677tl:cn-beijing
lastUpdateTime	string	The timestamp of the last metadata synchronization.	2024-12-17 15:44:17
dbNum	integer	The number of databases in the data source.	3
tableNum	integer	The number of tables in the data source.	1000
partitionNum	integer	The number of partitions in the data source.	10000000
createTime	string	The timestamp when the data source was created.	2024-12-17 09:29:58
status	string	The data source status. Valid values: STARTING : STARTING STOPPED : STOPPED STARTED : STARTED START_FAILED : START_FAILED STOPPING : STOPPING STOP_FAILED : STOP_FAILED	STARTED
errMsg	string	The error message if starting or stopping the data source instance fails. This field is populated only when `status` is `START_FAILED` or `STOP_FAILED`.	unexpected exception
config	array<object>	The data source configurations.
	object	A data source configuration object.
name	string	The configuration name.	Range partition table migration method
key	string	The unique configuration key.	bigquery.range.partition.migrate.type
desc	string	The configuration description.	Range partition table migration method
placeHolder	string	An example configuration value.	Cluster or Partition
type	string	The configuration type. Valid values: `boolean`, `int`, `map`, `string`, `password`, and `file`. Valid values: password : password boolean : boolean file : file string : string map : map int : int	string
subType	string	The file subtype, such as .keytab. This parameter applies only if `type` is `file`.	.keytab
value	any	The configuration value.	Partition
enums	array	The enumerated configuration values.
	string	A single enumerated value.	Partition
required	boolean	Indicates whether the configuration is required.	true
group	string	The configuration group.	basic_group
agentIsOnline	boolean	Indicates whether the agent for the data source instance is online.	true
tablesDoingNum	integer	The number of tables being migrated.	18
tablesDoneNum	integer	The number of successfully migrated tables.	2323
tablesPartDoneNum	integer	The number of partially migrated tables.	22
tablesFailedNum	integer	The number of tables that failed to migrate.	2
partitionsDoingNum	integer	The number of partitions being migrated.	2332
partitionsDoneNum	integer	The number of successfully migrated partitions.	23
partitionsFailedNum	integer	The number of partitions that failed to migrate.	2323
scanId	integer	The metadata synchronization task ID.	1000253
scanStatus	string	The status of the metadata synchronization task.
scanErrMsg	string	The error message for a failed metadata synchronization task.
pageNum	integer	The page number.	1
pageSize	integer	The number of data sources to return per page.	20

Examples

Success response

JSON format

{
  "requestId": "C1F7715F-D316-5AB6-BD02-5241083F4003",
  "data": {
    "total": 9,
    "objectList": [
      {
        "id": 2000015,
        "region": "cn-beijing",
        "name": "demo",
        "dstProject": "mms_test",
        "dstProjects": [
          "mms_test"
        ],
        "type": "BIGQUERY",
        "networklink": "vpc-2zebqp6uojhdla46677tl:cn-beijing\n",
        "lastUpdateTime": "2024-12-17 15:44:17\n",
        "dbNum": 3,
        "tableNum": 1000,
        "partitionNum": 10000000,
        "createTime": "2024-12-17 09:29:58\n\n",
        "status": "STARTED",
        "errMsg": "unexpected exception\n",
        "config": [
          {
            "name": "Range partition table migration method",
            "key": "bigquery.range.partition.migrate.type\n",
            "desc": "Range partition table migration method",
            "placeHolder": "Cluster or Partition\n",
            "type": "string",
            "subType": ".keytab",
            "value": "Partition\n",
            "enums": [
              "Partition"
            ],
            "required": true,
            "group": "basic_group"
          }
        ],
        "agentIsOnline": true,
        "tablesDoingNum": 18,
        "tablesDoneNum": 2323,
        "tablesPartDoneNum": 22,
        "tablesFailedNum": 2,
        "partitionsDoingNum": 2332,
        "partitionsDoneNum": 23,
        "partitionsFailedNum": 2323,
        "scanId": 1000253,
        "scanStatus": "",
        "scanErrMsg": ""
      }
    ],
    "pageNum": 1,
    "pageSize": 20
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.