ListMmsTables - MaxCompute - Alibaba Cloud Documentation Center

Lists the tables in a MaxCompute Migration Assist (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:ListMmsTables

list

*project

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

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
sourceId	integer	Yes	The ID of the data source.	2000015
onlyName	boolean	No	Specifies whether to return only the names of the tables.	false
dbId	integer	No	The ID of the database.	197
dbName	string	No	The name of the database.	mms_test
name	string	No	The name of the table.	test
dstProjectName	string	No		mms_test
dstSchemaName	string	No		default
dstName	string	No		test
type	string	No	The table type.	MANAGED_TABLE
hasPartitions	boolean	No	The partitioned table.	true
status	array	No	The status of the migration.
	string	No	The migration status. Valid values: PART_DONE : The migration is partially successful. INIT : The migration has not started. DONE : The migration is successful. DOING : The migration is in progress. FAILED : The migration failed.	["DONE", "FAILED"]
lastDdlTimeStart	string	No	The beginning of the time range for the lastDdlTime.	2024-12-17 15:44:42
lastDdlTimeEnd	string	No	The sort order of the tables by lastDdlTime.	2024-12-19 15:44:42
pageNum	integer	No	The sorting order for the table size.	1
pageSize	integer	No	The number of entries to return on each page.	10
sorter.numRows	string	No	The sort order of the tables by lastDdlTime. Valid values: asc : Ascending order desc : Descending order	desc
sorter.size	string	No	The sorting order for the table size. Valid values: asc : ascending order. desc : descending order.	asc
sorter.lastDdlTime	string	No	The number of entries to return on each page. Valid values: asc : Ascending order desc : Descending order	desc

Response elements

Element	Type	Description	Example
	object	The return value.
requestId	string	The request ID.	E7FB14F1-4ACD-5C73-A755-B302D70AB9AD
data	object	The returned data.
total	integer	The total number of records.	100
objectList	array<object>	The list of tables.
	object	The table information.
id	integer	The table ID.	1003476
dbId	integer	The database ID.	196
dbName	string	The database name.	demo
name	string	The table name.	test
dstProjectName	string		mms_test
dstSchemaName	string		default
dstName	string		test
type	string	The table type.	MANAGED_TABLE
hasPartitions	boolean	Indicates whether the table is a partitioned table.	true
schema	object	The table schema.
name	string	The table name.	test
comment	string	The comment on the table.	for mms test
columns	array<object>	The non-partition key columns.
	object	A non-partition key column.
name	string	The column name.	user_id
type	string	The column type.	bigint
comment	string	The comment on the column.	user id
defaultValue	string	The default value of the column.	""
nullable	boolean	Indicates whether the column can be null.	false
partitions	array<object>	The partition key columns.
	object	A partition key column.
name	string	The column name.	p1
type	string	The column type.	string
comment	string	The comment on the column.	第一分区
defaultValue	string	The default value of the column.	abc
nullable	boolean	Indicates whether the column can be null.	false
owner	string	The owner of the table.	Hive
location	string	The storage location of the table.	\| hdfs://master-1-1.c-c127cd184bb029ea.cn-zhangjiakou.emr.aliyuncs.com:9000/user/hive/warehouse/demo
inputFormat	string	The input format.	org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat
outputFormat	string	The output format.	org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat
serde	string	The serializer/deserializer (SerDe).	org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe
extra	string	Other information in the JSON format.	{"mapkey.delim":":","collection.delim":",","serialization.format":"\|","field.delim":"\|"}
partitions	integer	The number of partitions.	100
partitionsDoing	integer	The number of partitions that are being migrated.	20
partitionsDone	integer	The number of partitions that are migrated.	60
partitionsFailed	integer	The number of partitions that failed to be migrated.	40
sourceId	integer	The ID of the data source.	2000028
sourceName	string	The name of the data source.	demo
size	integer	The data size, in bytes.	2985028
numRows	integer	The number of rows.	232323
updated	boolean	Indicates whether the metadata is updated.	true
lastDdlTime	string	The last DDL time.	2024-12-17 15:44:42
status	string	The migration status. Valid values: PART_DONE : The migration is partially successful. INIT : The migration has not started. DONE : The migration is successful. DOING : The migration is in progress. FAILED : The migration failed.	DONE
pageNum	integer	The page number.	1
pageSize	integer	The number of entries per page.	20

Examples

Success response

JSON format

{
  "requestId": "E7FB14F1-4ACD-5C73-A755-B302D70AB9AD",
  "data": {
    "total": 100,
    "objectList": [
      {
        "id": 1003476,
        "dbId": 196,
        "dbName": "demo",
        "name": "test",
        "dstProjectName": "mms_test",
        "dstSchemaName": "default",
        "dstName": "test",
        "type": "MANAGED_TABLE",
        "hasPartitions": true,
        "schema": {
          "name": "test",
          "comment": "for mms test",
          "columns": [
            {
              "name": "user_id",
              "type": "bigint",
              "comment": "user id",
              "defaultValue": "\"\"",
              "nullable": false
            }
          ],
          "partitions": [
            {
              "name": "p1",
              "type": "string",
              "comment": "第一分区",
              "defaultValue": "abc",
              "nullable": false
            }
          ]
        },
        "owner": "Hive",
        "location": "| hdfs://master-1-1.c-c127cd184bb029ea.cn-zhangjiakou.emr.aliyuncs.com:9000/user/hive/warehouse/demo",
        "inputFormat": "org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat ",
        "outputFormat": "org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat",
        "serde": "org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe",
        "extra": "{\"mapkey.delim\":\":\",\"collection.delim\":\",\",\"serialization.format\":\"|\",\"field.delim\":\"|\"}   ",
        "partitions": 100,
        "partitionsDoing": 20,
        "partitionsDone": 60,
        "partitionsFailed": 40,
        "sourceId": 2000028,
        "sourceName": "demo ",
        "size": 2985028,
        "numRows": 232323,
        "updated": true,
        "lastDdlTime": "2024-12-17 15:44:42\n",
        "status": "DONE"
      }
    ],
    "pageNum": 1,
    "pageSize": 20
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.