ListMmsDataSources-阿里云帮助中心

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 pagination is not used, all data sources are returned.	1
pageSize	integer	No	The number of entries per page. If pagination is not used, 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 response payload.
total	integer	The total number of data sources.	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 : A Hive data source. BIGQUERY : A Google BigQuery data source. MAXCOMPUTE : An Alibaba Cloud MaxCompute data source.	BIGQUERY
networklink	string	The network connection, specified in the `VpcId:RegionId` format.	vpc-2zebqp6uojhdla46677tl:cn-beijing
lastUpdateTime	string	The last metadata synchronization time.	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 the data source was created.	2024-12-17 09:29:58
status	string	The data source status. Valid values: STARTING : The data source is being started. STOPPED : The data source is stopped. STARTED : The data source is started. START_FAILED : The data source failed to start. STOPPING : The data source is being stopped. STOP_FAILED : The data source failed to stop.	STARTED
errMsg	string	The reason the data source instance failed to start or stop. This parameter is returned only if the `status` is `START_FAILED` or `STOP_FAILED`.	unexpected exception
config	array<object>	A list of data source configurations.
	object	A data source configuration object.
name	string	The configuration name.	范围分区表迁移方式
key	string	The unique key for the configuration.	bigquery.range.partition.migrate.type
desc	string	The description of the configuration.	范围分区表迁移方式
placeHolder	string	A placeholder for the configuration value.	Cluster or Partition
type	string	The configuration type. Valid values: password : A password field. boolean : A boolean field. file : A file field. string : A string field. map : A map field. int : An integer field.	string
subType	string	The required file extension (for example, `.keytab`) when `type` is `file`.	.keytab
value	any	The configuration value.	Partition
enums	array	A list of valid values for the configuration.
	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 currently 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 currently 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 ID of the metadata synchronization task.	1000253
scanStatus	string
scanErrMsg	string
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,
        "scanStatus": "",
        "scanErrMsg": ""
      }
    ],
    "pageNum": 1,
    "pageSize": 20
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.