DocsICP FilingConsole
Documentation

ListPartitions

Updated at:
Copy as MD
Product
My Favorites

Queries the partition list of a specified table in DataWorks Data Map. Currently supports MaxCompute and HMS (EMR cluster) types.

Operation description

  1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.

  2. Only MaxCompute and HMS (EMR cluster) table types are supported.

  3. Before calling this API, call ListCrawlers to obtain the MetaEntityId of the metadata crawler, then call ListDatabases to obtain the database ID. For MaxCompute projects with Schema enabled, call ListSchemas to obtain the schema ID. Then call ListTables to obtain the TableId, and pass the returned table ID to this API.

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

dataworks:ListPartitions

list

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
TableId

string

Yes

The ID of the table. You can obtain this value from the response of the ListTables operation. For more information, see Metadata entity concepts.

maxcompute-table:::project_name:[schema_name]:table_name
Name

string

No

The partition name. Fuzzy match is supported. This parameter is valid only for MaxCompute tables.

ds=20250101
SortBy

string

No

The field by which to sort the results. Default value: CreateTime. Valid values:

  • CreateTime: the creation time. Only MaxCompute tables are supported.

  • ModifyTime: the modification time. Only MaxCompute tables are supported.

  • Name: the name. This is the sort method used for HMS tables.

  • RecordCount: the number of records. Only MaxCompute tables are supported.

  • DataSize: the storage size. Only MaxCompute tables are supported.

Valid values:

  • ModifyTime :

    the modification time. Only MaxCompute tables are supported.

  • CreateTime :

    the creation time. Only MaxCompute tables are supported.

  • DataSize :

    the storage size. Only MaxCompute tables are supported.

  • RecordCount :

    the number of records. Only MaxCompute tables are supported.

  • Name :

    the name. This is the sort method used for HMS tables.

CreateTime
Order

string

No

The sort direction. Default value: Asc. Valid values:

  • Asc: ascending order.

  • Desc: descending order.

Valid values:

  • Asc :

    ascending order.

  • Desc :

    descending order.

Asc
PageNumber

integer

No

The page number. Default value: 1.

1
PageSize

integer

No

The number of entries per page. Default value: 10. Maximum value: 100.

10

Response elements

Element

Type

Description

Example

object

The response parameters.

RequestId

string

The request ID.

D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx
Success

boolean

Indicates whether the request was successful.

true
PagingInfo

object

The pagination result.

TotalCount

integer

The total number of records.

1
PageNumber

integer

The page number.

1
PageSize

integer

The number of entries per page.

10
PartitionList

array

The partition list of the table.

Partition

The partition of the table.

Examples

Success response

JSON format

{
  "RequestId": "D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "PartitionList": [
      {
        "TableId": "maxcompute-table:accountId::project::table",
        "Name": "ds=20250101",
        "CreateTime": 1700192563000,
        "ModifyTime": 1700192563000,
        "RecordCount": 1000000,
        "DataSize": 4096
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.