ListPartitionSummaries - Data Lake Formation - Alibaba Cloud Documentation Center

Retrieves storage overview for partitions.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET /dlf/v1/{catalogId}/databases/{database}/tables/{table}/partitions/storage-summary HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
catalogId	string	Yes	The catalog ID.	clg-paimon-xxxx
database	string	Yes	The database name.	default
table	string	Yes	The table name.	table1
maxResults	integer	No	The number of entries to return on each page.	100
pageToken	string	No	The token for the next page of results. If the response does not include this token, pass an empty string ("").	""
partitionNamePattern	string	No	The partition name pattern.	hh=10

Response elements

Element	Type	Description	Example
	PartitionSummaries	The storage overview for partitions.

Examples

Success response

JSON format

{
  "partitions": [
    {
      "databaseName": "",
      "tableName": "",
      "partitionName": "",
      "createdAt": 0,
      "totalFileSizeInBytes": 0,
      "totalFileCount": 0,
      "lastAccessTime": 0,
      "updatedAt": 0,
      "storageClass": "",
      "storageActionTimestamp": 0,
      "storageActionParams": {
        "key": ""
      }
    }
  ],
  "nextPageToken": ""
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.