ListDataLakeDatabase - 获取数据湖的数据库列表 - 数据管理 DMS

调用此API可以获取数据湖的数据库列表。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dms:ListDataLakeDatabase	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
DataRegion	string	是	数据湖所属的地域。	cn-hangzhou
CatalogName	string	是	查询的数据目录名称。	hive
SearchKey	string	是	搜索数据库名称的关键字。	default
Tid	long	否	租户 ID。说明鼠标移动到界面右上角的头像处，查看租户 ID。具体操作，请参见查看租户信息。	3****
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	f056501ada12c1cc
MaxResults	integer	否	分页大小。最大值为 100。	20

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID，用于定位日志，排查问题。	4E1D2B4D-3E53-4ABC-999D-1D2520B3471A
Success	boolean	请求是否成功，返回值如下： true：请求成功 false：请求失败	true
ErrorCode	string	错误码。	400
ErrorMessage	string	错误信息。	UnknownError
DatabaseList	array	数据库列表。
Database	DLDatabase	数据库详情。
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	NesLoKLEdIZrKhDT7I2gSw==
MaxResults	integer	限定每次返回的最大条数，可以和 nextToken 搭配使用实现翻页能力	20

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。