GetDataLakeDatabase - 获取数据湖的数据库信息 - 数据管理 DMS

调用此API可以获取数据湖中的数据库信息。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
DataRegion	string	是	数据湖所属的地域。	cn-hangzhou
CatalogName	string	是	数据目录名。	hive
Name	string	是	数据库名称。	default
Tid	long	否	租户 ID。说明取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。	3

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	E5EE2B9E-2F95-57FA-B284-CB441CEE49D6
Success	boolean	请求是否成功，返回值如下： true：请求成功。 false：请求失败。	true
ErrorCode	string	错误码。	404
ErrorMessage	string	错误信息。	code: 404, can not find catalog, name : hive1 request id: FF737753-9641-1F51-AFDA-7DF541114B29
Database	DLDatabase	数据库信息。

示例

正常返回示例

JSON格式

{
  "RequestId": "E5EE2B9E-2F95-57FA-B284-CB441CEE49D6",
  "Success": true,
  "ErrorCode": "404",
  "ErrorMessage": "code: 404, can not find catalog, name : hive1 request id: FF737753-9641-1F51-AFDA-7DF541114B29",
  "Database": {
    "Description": "Default database for catalog hive",
    "Parameters": {
      "test": "test",
      "test2": 1
    },
    "DbId": 19,
    "CatalogName": "hive",
    "Name": "default",
    "Location": "oss://xxx"
  }
}

错误码

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