Obtaining Information About All Catalogs in a Project

Function

This API is used to obtain information about all catalogs in a specified project.

URI

GET /v3/{project_id}/catalogs

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which is used for resource isolation. For how to obtain a project ID, see Obtaining a Project ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Offset. The default value is 0.
limit	No	Integer	Number of returned records displayed on each page. The default value is 100.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
is_success	Boolean	Whether the request is successful.
total_count	Long	Total number of catalogs.
catalogs	Array of objects	Information about all catalogs in the project. For details, see CatalogEntity.

**Table 4** catalogs parameter descriptions
Parameter	Type	Description
name	String	Catalog mapping name on DLI.
create_time	Long	Catalog creation time.
parameters	Map<String,String>	Catalog attributes include type and externalCatalog.
description	String	Description of the catalog.
status	String	Catalog status. The options are: CREATING: The catalog is being created. ACTIVE: The catalog is available. FAILED: The catalog failed to create.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Failure cause.

Example Request

None

Example Response

{
 "is_success": true,
 "total_count": 2,
 "catalogs": [
  {
   "name": "catalog_test1",
   "create_time": 1697179174000,
   "parameters": {
    "type": "lakeformation",
    "external_catalog_name": "lakeformation_catalog_test1"
   },
   "description": "dli default catalog"
  },
  {
   "name": "catalog_test2",
   "create_time": 1706595479942,
   "parameters": {
    "type": "lakeformation",
    "external_catalog_name": "lakeformation_catalog_test2"
   },
   "description": ""
  }
 ]
}

Status Codes

Status Code	Description
200	The request is successful.
400	Request error.
403	Access to the requested page is forbidden.
404	The server cannot find the requested page.
500	Internal server error.