ListMmsDataSources - MaxCompute - Alibaba Cloud Documentation Center

Lists the 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. If you leave this parameter empty, all data sources are returned.	1
pageSize	integer	No	The number of entries to return on each page. If you leave this parameter empty, all data sources are returned.	10

Response elements

Element	Type	Description	Example
	object	The paginated data.
requestId	string	The request ID.	C1F7715F-D316-5AB6-BD02-5241083F4003
data	object	The returned data.
total	integer	The total number of records.	9
objectList	array<object>	The list of data sources.
	object	The data source.
id	integer	The data source ID.	2000015
region	string	The region ID.	cn-beijing
name	string	The name of the data source.	demo
dstProject	string		mms_test
dstProjects	array
	string		mms_test
type	string	The type of the data source. Valid values: HIVE : HIVE BIGQUERY : BIGQUERY MAXCOMPUTE : MAXCOMPUTE	BIGQUERY
networklink	string	The MaxCompute network connectivity ID and the region ID.	vpc-2zebqp6uojhdla46677tl:cn-beijing
lastUpdateTime	string	The last time when the metadata was synchronized.	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 time when the data source was created.	2024-12-17 09:29:58
status	string	The status of the data source. Valid values: STARTING : STARTING STOPPED : STOPPED STARTED : STARTED START_FAILED : START_FAILED STOPPING : STOPPING STOP_FAILED : STOP_FAILED	STARTED
errMsg	string	The reason why the data source instance failed to start or shut down. This parameter is returned only when the value of `status` is `START_FAILED` or `STOP_FAILED`.	unexpected exception
config	array<object>	The configurations of the data source.
	object	The configurations of the data source.
name	string	The name of the configuration.	范围分区表迁移方式
key	string	The English identifier for the configuration.	bigquery.range.partition.migrate.type
desc	string	The description of the configuration.	范围分区表迁移方式
placeHolder	string	An example value for the configuration.	Cluster or Partition
type	string	The type of the configuration. 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	If `type` is set to `file`, `subType` specifies the file type, such as `.keytab`.	.keytab
value	any	The value of the configuration.	Partition
enums	array	The enumerated values for the configuration.
	string	An enumerated value for the configuration.	Partition
required	boolean	Indicates whether the configuration is required.	true
group	string	The configuration group.	basic_group
agentIsOnline	boolean	Indicates whether the data source instance or its associated agent is started.	true
tablesDoingNum	integer	The number of tables that are being migrated.	18
tablesDoneNum	integer	The number of tables that have been migrated.	2323
tablesPartDoneNum	integer	The number of tables that are partially migrated.	22
tablesFailedNum	integer	The number of tables that failed to be migrated.	2
partitionsDoingNum	integer	The number of partitions that are being migrated.	2332
partitionsDoneNum	integer	The number of partitions that have been migrated.	23
partitionsFailedNum	integer	The number of partitions that failed to be migrated.	2323
scanId	integer	The ID of the metadata synchronization task.	1000253
pageNum	integer	The page number.	1
pageSize	integer	The number of entries 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": "范围分区表迁移方式\n",
            "key": "bigquery.range.partition.migrate.type\n",
            "desc": "范围分区表迁移方式\n",
            "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
      }
    ],
    "pageNum": 1,
    "pageSize": 20
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.