ListDatabaseDetails - Data Lake Formation - Alibaba Cloud Documentation Center

Retrieves database details.

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}/database-details HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
catalogId	string	Yes	The catalog ID.	clg-paimon-xxx
maxResults	integer	No	The number of entries to return on each page. Default value: 1000. Maximum value: 1000.	1000
pageToken	string	No	The token to retrieve the next page of results. If the response does not include this token, pass an empty string ("").	""
databaseNamePattern	string	No	The database name pattern for fuzzy matching. Supports the percent sign (%).	database%

Response elements

Element	Type	Description	Example
	object	The response body.
nextPageToken	string	The token to retrieve the next page of results. A null value indicates that all results have been retrieved.	E8ABEB1C3DB893D16576269017992F57
databaseDetails	array	The databases.
	Database	Th database.

Examples

Success response

JSON format

{
  "nextPageToken": "\t\nE8ABEB1C3DB893D16576269017992F57\n",
  "databaseDetails": [
    {
      "owner": "acs:ram::[accountId]:root",
      "createdAt": 1744970111419,
      "updatedBy": "acs:ram::[accountId]:root",
      "createdBy": "acs:ram::[accountId]:root",
      "name": "test_database",
      "options": {
        "key": "{\\\"comment\\\":\\\"测试\\\"}"
      },
      "location": "oss://clg-paimon-xxx/db-xxx\n",
      "id": "1",
      "updatedAt": 1744970111419
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.