All Products
Search

This Product

    Data Lake Formation:GetDatabaseSummary

    Document Center

    Data Lake Formation:GetDatabaseSummary

    Last Updated:Dec 16, 2025

    Retrieves the storage overview of a database.

    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}/storage-summary HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    catalogId

    string

    Yes

    The ID of the catalog.

    clg-paimon-xxxx

    database

    string

    Yes

    The name of the database.

    default

    date

    string

    No

    Response elements

    Element

    Type

    Description

    Example

    DatabaseSummary

    The storage overview of the database.

    Examples

    Success response

    JSON format

    {
  "databaseName": "",
  "createdAt": 0,
  "location": "",
  "tableCount": 0,
  "partitionCount": 0,
  "totalFileSizeInBytes": 0,
  "totalFileCount": 0,
  "generatedDate": "",
  "objTypeStandardSize": 0,
  "objTypeIaSize": 0,
  "objTypeArchiveSize": 0,
  "objTypeColdArchiveSize": 0,
  "totalMetaSizeInBytes": 0
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.