ListDataLakeDatabase-阿里云帮助中心

Retrieves a list of databases in a data lake.

Try it now

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:ListDataLakeDatabase

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CatalogName	string	Yes	The name of the catalog. To find the catelog name, go to the Data Lake console.	hive
SearchKey	string	No	A keyword to search for database names.	default
Tid	integer	No	The tenant ID. Note Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see View tenant information.	3****
NextToken	string	No	The token that is used to retrieve the next page of results. Valid values: If NextToken is empty, no more results are available. If NextToken has a value, it is the token for the next query.	f056501ada12****
MaxResults	integer	No	The number of entries to return on each page. The maximum value is 100.	20
WorkspaceId	integer	No	The workspace ID.	12****

Response elements

Element	Type	Description	Example
	object	Schema of Response.
RequestId	string	The request ID, used for log tracing and troubleshooting.	4E1D2B4D-3E53-4ABC-999D-1D2520B3****
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.	400
ErrorMessage	string	The error message.	UnknownError
DatabaseList	array	The list of databases.
	DLDatabase	The details of the database.
NextToken	string	The token that is used to retrieve the next page of results. If this parameter is empty, no more results are available.	NesLoKLEdIZrKhDT7I2g****
MaxResults	integer	The maximum number of entries returned per page. This parameter is used with `NextToken` for paging.	20

Examples

Success response

JSON format

{
  "RequestId": "4E1D2B4D-3E53-4ABC-999D-1D2520B3****",
  "Success": true,
  "ErrorCode": "400",
  "ErrorMessage": "UnknownError",
  "DatabaseList": [
    {
      "Description": "Default database for catalog hive\n",
      "Parameters": {
        "test": "test",
        "test2": 1
      },
      "DbId": 19,
      "CatalogName": "hive",
      "Name": "default",
      "Location": "oss://xxx"
    }
  ],
  "NextToken": "NesLoKLEdIZrKhDT7I2g****",
  "MaxResults": 20
}

Error codes

See for a complete list.

Release notes

See 变更详情 for a complete list.