ListDataLakeDatabase API Overview - Data Management - Alibaba Cloud - Data Management

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

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
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 catalog name in the DLF console.	hive
SearchKey	string	No	The keyword used to search for databases.	default
Tid	integer	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 for the next request. Valid values: If NextToken is empty, no next page exists. If a value of NextToken is returned, the value is the token for the next query.	f056501ada12c1cc
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 100.	20
WorkspaceId	integer	No	The workspace ID.	12****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID. You can use this ID to locate logs and troubleshoot issues.	4E1D2B4D-3E53-4ABC-999D-1D2520B3471A
Success	boolean	Indicates whether the request was successful. true: The request was successful. false: The request failed.	true
ErrorCode	string	The error code returned if the request failed.	400
ErrorMessage	string	The error message returned if the request failed.	UnknownError
DatabaseList	array	The list of databases.
	DLDatabase	The information about the database.
NextToken	string	The pagination token for the next request. If NextToken is empty, no next page exists. Set this parameter to the NextToken value from the previous response.	NesLoKLEdIZrKhDT7I2gSw==
MaxResults	integer	The maximum number of entries per request. You can use this parameter with NextToken for pagination.	20

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.