ListDataLakeCatalog - 获取数据湖的数据目录列表 - 数据管理 DMS

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dms:ListDataLakeCatalog

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
DataRegion	string	是	数据湖所属的地域。	cn-hangzhou
SearchKey	string	否	搜索数据库目录名称的关键字。	hive
Tid	integer	否	租户 ID。您可调用 GetUserActiveTenant 或 ListUserTenants 接口获取该参数的值。	3
WorkspaceId	integer	否	工作空间 ID。	12****

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID，用于定位日志，排查问题。	E76DD2E7-EBAC-5724-B163-19AAC233F8F2
Success	boolean	请求是否成功，返回值如下： true：请求成功。 false：请求失败。	true
ErrorCode	string	错误码。	400
ErrorMessage	string	错误信息。	UnknownError
CataLogList	array	数据目录列表。
	DLCatalog	数据目录。

示例

正常返回示例

JSON格式

{
  "RequestId": "E76DD2E7-EBAC-5724-B163-19AAC233F8F2",
  "Success": true,
  "ErrorCode": "400",
  "ErrorMessage": "UnknownError",
  "CataLogList": [
    {
      "Description": "init default catalog",
      "Name": "hive",
      "Location": "oss://xxxx"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。