ListMmsDbs - MaxCompute - Alibaba Cloud Documentation Center

List databases in the MMA data source.

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

list

*Project

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
sourceId	integer	Yes	Data source ID	2000018

Request parameters

Parameter	Type	Required	Description	Example
name	string	No	Data source name	demo
status	string	No	Data source status Valid values: STARTING : STARTING STARTTED : STARTTED STOPPED : STOPPED START_FAILED : START_FAILED STOPPING : STOPPING STOP_FAILED : STOP_FAILED	STARTED
sorter	object	No	Sorting conditions
numRows	string	No	Number of data rows in the database Valid values: asc : asc desc : desc	desc
size	string	No	Size of data in the database Valid values: asc : asc desc : desc	asc
updateTime	string	No	Update time	2024-12-17 15:44:17
pageNum	integer	No	Page number	1
pageSize	integer	No	Number of records per page	10

Response elements

Element	Type	Description	Example
	object	Return value
requestId	string	Request ID.	CF3F9978-260F-5204-94BE-30A4E6B54443
data	object	Returned data.
total	integer	Total number of records.	13
objectList	array<object>	Database list
	object	Database information
id	integer	Database ID	1530
name	string	Database name	mms_test
description	string	Database description	for mms test
owner	string	Database owner	System user
location	string	Database storage location	hdfs://master-1-1.c-6fc187819ed6bae0.cn-shanghai.emr.aliyuncs.com:9000/user/hive/warehouse
extra	string	Other information stored in JSON format	{}
tables	integer	Number of tables	100
tablesDoing	integer	Tables being migrated	20
tablesDone	integer	Tables migrated	20
tablesPartDone	integer	Partially migrated tables	20
tablesFailed	integer	Failed tables	20
partitions	integer	Number of partitions	1000
partitionsDoing	integer	Partitions being migrated	400
partitionsDone	integer	Partitions migrated	200
partitionsFailed	integer	Failed partitions	200
sourceId	integer	Data source ID.	2000015
sourceName	string	Data source name	demo
size	integer	Database data size in bytes	2342342
numRows	integer	Number of database data rows	23232
updated	boolean	Whether data is updated	true
lastDdlTime	string	Last DDL Time	2024-12-17 15:44:42
createTime	string	Time created in MMS	2024-12-17 15:44:42
updateTime	string	Latest data update time	2024-12-17 15:44:42
status	string	Migration status: INIT, DOING, FAILED, DONE, PART_DONE Valid values: PART_DONE : Partially completed INIT : Not migrated DONE : Completed DOING : Migrating FAILED : Failed	DOING
deleted	boolean	Whether deleted	false
dstProjectName	string	Target MaxCompute project name	mms_test
dstName	string	The MaxCompute schema corresponding to the source database. If the target MaxCompute project does not have a schema layer enabled, this value is null. By default, it is consistent with the source database name.	default
pageSize	integer	Page size	10
pageNum	integer	Page number	1

Examples

Success response

JSON format

{
  "requestId": "CF3F9978-260F-5204-94BE-30A4E6B54443",
  "data": {
    "total": 13,
    "objectList": [
      {
        "id": 1530,
        "name": "mms_test",
        "description": "for mms test",
        "owner": "System user",
        "location": " hdfs://master-1-1.c-6fc187819ed6bae0.cn-shanghai.emr.aliyuncs.com:9000/user/hive/warehouse  ",
        "extra": "{}",
        "tables": 100,
        "tablesDoing": 20,
        "tablesDone": 20,
        "tablesPartDone": 20,
        "tablesFailed": 20,
        "partitions": 1000,
        "partitionsDoing": 400,
        "partitionsDone": 200,
        "partitionsFailed": 200,
        "sourceId": 2000015,
        "sourceName": "demo",
        "size": 2342342,
        "numRows": 23232,
        "updated": true,
        "lastDdlTime": "2024-12-17 15:44:42\n",
        "createTime": "2024-12-17 15:44:42\n",
        "updateTime": "2024-12-17 15:44:42\n",
        "status": "DOING",
        "deleted": false,
        "dstProjectName": "mms_test",
        "dstName": "default"
      }
    ],
    "pageSize": 10,
    "pageNum": 1
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.