GetDatabase - DataWorks - Alibaba Cloud Documentation Center

Queries the information about a specific database in Data Map.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Id	string	Yes	Database entity ID. You can refer to the response of the ListDatabases operation and Concepts related to metadata entities. The format: `${EntityType}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name}`. Use empty strings as placeholders for levels that do not exist. Note For StarRocks, the catalog identifier is the catalog name. For DLF, the catalog identifier is the catalog ID. For other types, the catalog-level hierarchy is not supported, and an empty string can be used as a placeholder. Examples of common ID formats `dlf-database::catalog_id:database_name` `holo-database:instance_id::database_name` `mysql-database:(instance_id\|encoded_jdbc_url)::database_name` Note `catalog_id`: The ID of the DLF catalog. `instance_id`: The instance ID, which is required when the data source is registered in instance mode. `encoded_jdbc_url`: The encoded JDBC connection string, which is required when the data source is registered in connection-string mode. `database_name`: The database name.	mysql-database:rm-abc123xxx::test_db

Response parameters

Parameter	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	1AFAE64E-D1BE-432B-A9****
Success	boolean	Indicates whether the request was successful.	true
Database	Database	The database details.

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AFAE64E-D1BE-432B-A9****",
  "Success": true,
  "Database": {
    "Id": "holo-database:h-xxxx::test_db",
    "Name": "test_db",
    "Comment": "test comment",
    "LocationUri": "oss://test-bucket/test_db",
    "ParentMetaEntityId": "holo:h-xxxx",
    "CreateTime": 1736852168000,
    "ModifyTime": 1736852168000
  }
}

Error codes

For a list of error codes, visit the Service error codes.