ListMmsDbs-阿里云帮助中心

Lists the databases in an 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	The ID of the data source.	2000018

Request parameters

Parameter	Type	Required	Description	Example
name	string	No	The name of the data source.	demo
status	string	No	The status of the data source. Valid values: STARTING : STARTING STARTTED : STARTTED STOPPED : STOPPED START_FAILED : START_FAILED STOPPING : STOPPING STOP_FAILED : STOP_FAILED	STARTED
sorter	object	No	The sorting conditions.
numRows	string	No	The number of data rows in the database. Valid values: asc : asc desc : desc	desc
size	string	No	The size of data in the database. Valid values: asc : asc desc : desc	asc
updateTime	string	No	The update time. Format: YYYY-MM-DD HH:mm:ss.	2024-12-17 15:44:17
pageNum	integer	No	The page number.	1
pageSize	integer	No	The number of entries per page.	10

Response elements

Element	Type	Description	Example
	object	The return value.
requestId	string	The ID of the request.	CF3F9978-260F-5204-94BE-30A4E6B54443
data	object	The returned data.
total	integer	The total number of records.	13
objectList	array<object>	The list of databases.
	object	The database information.
id	integer	The ID of the database.	1530
name	string	The name of the database.	mms_test
description	string	The description of the database.	for mms test
owner	string	The owner of the database.	System user
location	string	The storage location of the database.	hdfs://master-1-1.c-6fc187819ed6bae0.cn-shanghai.emr.aliyuncs.com:9000/user/hive/warehouse
extra	string	The additional information stored in JSON format.	{}
tables	integer	The number of tables.	100
tablesDoing	integer	The tables being migrated.	20
tablesDone	integer	The tables that have been migrated.	20
tablesPartDone	integer	The tables that are partially migrated.	20
tablesFailed	integer	The tables that failed to migrate.	20
partitions	integer	The number of partitions.	1000
partitionsDoing	integer	The partitions being migrated.	400
partitionsDone	integer	The partitions that have been migrated.	200
partitionsFailed	integer	The partitions that failed to migrate.	200
sourceId	integer	The ID of the data source.	2000015
sourceName	string	The name of the data source.	demo
size	integer	The size of the database data, in bytes.	2342342
numRows	integer	The number of data rows in the database.	23232
updated	boolean	Indicates whether the data has been updated.	true
lastDdlTime	string	Last DDL Time	2024-12-17 15:44:42
createTime	string	The time when the database was created in MMS.	2024-12-17 15:44:42
updateTime	string	The latest update time of the data. Format: YYYY-MM-DD HH:mm:ss.	2024-12-17 15:44:42
status	string	The migration status. Valid values: INIT, DOING, FAILED, DONE, and PART_DONE. Valid values: PART_DONE : Partially completed. DONE : Completed. INIT : Not migrated. DOING : Migrating. FAILED : Failed.	DOING
deleted	boolean	Indicates whether the database has been deleted.	false
dstProjectName	string	The name of the destination MaxCompute project.	mms_test
dstName	string	The MaxCompute schema that corresponds to the source database. If the schema layer is not enabled for the destination MaxCompute project, this value is null. By default, this value is the same as the name of the source database.	default
pageSize	integer	The number of entries per page.	10
pageNum	integer	The 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.