ListMmsPartitions - MaxCompute - Alibaba Cloud Documentation Center

Lists the partitions 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:ListMmsPartitions

list

*project

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
sourceId	integer	Yes	The data source ID.	200018

Request parameters

Parameter	Type	Required	Description	Example
dbId	integer	No	The database ID.	2
dbName	string	No	The database name.	d1
updated	boolean	No	Filters partitions whose metadata has been updated.	false
tableName	string	No	The table name.	t1
tableId	integer	No	The ID of the table that contains the partition.	20323
value	string	No	The partition value.	p1=1/p2=abc
status	array	No	The migration status.
	string	No	The migration status. Valid values: INIT : Not migrated. DONE : Succeeded. DOING : Migrating. FAILED : Failed.	["DONE", "FAILED"]
lastDdlTimeStart	string	No	The minimum lastDdlTime value.	2024-12-17 15:44:42
lastDdlTimeEnd	string	No	The maximum lastDdlTime value.	2024-12-17 19:44:42
pageNum	integer	No	The page number to return.	1
pageSize	integer	No	The number of entries to return per page.	100
sorter.numRows	string	No	Sorts by number of rows. Valid values: asc : Ascending. desc : Descending.	desc
sorter.size	string	No	Sorts by data size. Valid values: asc : Ascending. desc : Descending.	asc
sorter.lastDdlTime	string	No	Sorts by lastDdlTime. Valid values: asc : Ascending. desc : Descending.	desc

Response elements

Element	Type	Description	Example
	object	The return value.
requestId	string	The request ID.	D9F872FD-5DDE-30A6-8C8A-1B8C6A81059F
data	object	The returned data.
total	integer	The total number of partitions.	1000
objectList	array<object>	The list of partitions.
	object	The partition object.
id	integer	The partition ID.	2323
dbId	integer	The ID of the database that contains the partition. The term "database" refers to different metadata layers across data sources. For example, it maps to Dataset in BigQuery, Database in Hive, Schema in Databricks, and Schema in MaxCompute.	196
tableId	integer	The table ID.	23
dbName	string	The database name. The term "database" refers to different metadata layers across data sources. For example, it maps to Dataset in BigQuery, Database in Hive, Schema in Databricks, and Schema in MaxCompute.	d1
tableName	string	The table name.	t1
value	string	The partition value.	p1=1/p2=abc
dstProjectName	string	The destination MaxCompute project name.	mms_test
dstSchemaName	string	The destination MaxCompute schema name. This field is empty for MaxCompute projects that do not use schemas.	default
dstTableName	string	The destination MaxCompute table name.	default
dstValue	string	The destination MaxCompute partition value. By default, this matches the source partition value.	p1=1/p2=abc
sourceId	integer	The data source ID.	200018
sourceName	string	The data source name.	demo
size	integer	The data size in bytes.	23223
numRows	integer	The number of rows.	2323
updated	boolean	Indicates whether the metadata has been updated.	false
lastDdlTime	string	The time when the DDL was last changed.	2024-12-17 15:44:42
status	string	The migration status. Valid values: INIT : Not migrated. DONE : Succeeded. DOING : Migrating. FAILED : Failed.	DONE
pageNum	integer	The page number.	1
pageSize	integer	The number of entries per page.	10

Examples

Success response

JSON format

{
  "requestId": "D9F872FD-5DDE-30A6-8C8A-1B8C6A81059F",
  "data": {
    "total": 1000,
    "objectList": [
      {
        "id": 2323,
        "dbId": 196,
        "tableId": 23,
        "dbName": "d1",
        "tableName": "t1",
        "value": "p1=1/p2=abc\n",
        "dstProjectName": "mms_test",
        "dstSchemaName": "default",
        "dstTableName": "default",
        "dstValue": "p1=1/p2=abc",
        "sourceId": 200018,
        "sourceName": "demo",
        "size": 23223,
        "numRows": 2323,
        "updated": false,
        "lastDdlTime": "2024-12-17 15:44:42\n",
        "status": "DONE"
      }
    ],
    "pageNum": 1,
    "pageSize": 10
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.