GetCatalogSummary - Data Lake Formation - Alibaba Cloud Documentation Center

Retrieves the storage overview of a catalog.

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

Request parameters

Parameter	Type	Required	Description	Example
catalogId	string	Yes	The ID of the catalog.	clg-paimon-xxxx
date	string	No

Response elements

Element	Type	Description	Example
	CatalogSummary	The storage overview of the catalog.

Examples

Success response

JSON format

{
  "databaseCount": {
    "lastDayValue": 0,
    "lastMonthValue": 0,
    "currentValue": 0
  },
  "tableCount": {
    "lastDayValue": 0,
    "lastMonthValue": 0,
    "currentValue": 0
  },
  "partitionCount": {
    "lastDayValue": 0,
    "lastMonthValue": 0,
    "currentValue": 0
  },
  "apiVisitCountMonthly": 0,
  "fileAccessCountMonthly": 0,
  "throughputMonthly": 0,
  "generatedDate": "",
  "objTypeStandardSize": 0,
  "objTypeIaSize": 0,
  "objTypeArchiveSize": 0,
  "objTypeColdArchiveSize": 0
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.