All Products
Search
Document Center

Data Lake Formation:GetCatalogById

Last Updated:Sep 22, 2025

Retrieves the details of a data 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/catalogs/id/{id} HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

id

string

Yes

The ID of the data catalog.

clg-paimon-xxxx

Response elements

Element

Type

Description

Example

Catalog

The data catalog.

Examples

Success response

JSON format

{
  "owner": "",
  "createdAt": 0,
  "updatedBy": "",
  "createdBy": "",
  "name": "",
  "id": "",
  "type": "",
  "updatedAt": 0,
  "status": "",
  "shareId": "",
  "options": {
    "key": ""
  },
  "isShared": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.