ListDataLakeDatabase - Data Management - Alibaba Cloud Documentation Center

Queries the list of databases in the data lake.

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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dms:ListDataLakeDatabase	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DataRegion	string	Yes	The region where the data lake resides.	cn-hangzhou
CatalogName	string	Yes	The name of the data catalog. You can view the name of the data catalog in the DLF console.	hive
SearchKey	string	Yes	The keyword that is used to search for databases.	default
Tid	long	No	The ID of the tenant. Note To view the tenant ID, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the View information about the current tenant section of the "Manage DMS tenants" topic.	3
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Valid values: If NextToken is empty, no next page exists. If a value of NextToken is returned, the value indicates the token that is used for the next query.	f056501ada12c1cc
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 100.	20
WorkspaceId	long	No	The workspace ID.	12****

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID. You can use the ID to locate logs and troubleshoot issues.	4E1D2B4D-3E53-4ABC-999D-1D2520B3471A
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrorCode	string	The error code returned if the call failed.	400
ErrorMessage	string	The error message that is returned if the request failed.	UnknownError
DatabaseList	array	The list of databases.
Database	DLDatabase	The information about the database.
NextToken	string	The pagination token that is used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists. Set this parameter to the value of NextToken obtained from the previous query.	NesLoKLEdIZrKhDT7I2gSw==
MaxResults	integer	The maximum number of entries to be returned in a request. You can use this parameter and NextToken to implement paging.	20

Examples

Sample success responses

JSONformat

{
  "RequestId": "4E1D2B4D-3E53-4ABC-999D-1D2520B3471A",
  "Success": true,
  "ErrorCode": 400,
  "ErrorMessage": "UnknownError",
  "DatabaseList": [
    {
      "Description": "",
      "Parameters": "",
      "DbId": 0,
      "CatalogName": "",
      "Name": "",
      "Location": ""
    }
  ],
  "NextToken": "NesLoKLEdIZrKhDT7I2gSw==",
  "MaxResults": 20
}

Error codes

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