ListCatalogs - 获取数据目录列表_数据湖构建(DLF)-阿里云帮助中心

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dlf:ListCatalogs

get

*全部资源

*

无

请求语法

GET /dlf/v1/catalogs HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
maxResults	integer	否	一次获取的最大记录数。	1000
pageToken	string	否	翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（''）。	""
catalogNamePattern	string	否	目录名称模式	mi

返回参数

名称	类型	描述	示例值
	object	ListCatalogsResponseBody
catalogs	array	Catalog 列表。
	Catalog	数据目录。
nextPageToken	string	翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。	E8ABEB1C3DB893D16576269017992F57

示例

正常返回示例

JSON格式

{
  "catalogs": [
    {
      "owner": "acs:ram::[accountId]:root",
      "createdAt": 1744970111419,
      "updatedBy": "acs:ram::[accountId]:root",
      "createdBy": "acs:ram::[accountId]:root",
      "name": "test_catalog",
      "id": "clg-paimon-xxxx",
      "type": "",
      "updatedAt": 1744970111419,
      "status": "NEW // 新建状态，资源未初始化\nINITIALIZING // 创建中\nINITIALIZE_FAILED // 初始化失败\nRUNNING // 创建成功\nTERMINATED // 异常终止，例如欠费\nDELETING // 删除中\nDELETE_FAILED // 删除失败\nDELETED // 已删除\nSTORAGE_RESTRICTED // 达到存储容量上限，进入存储受限状态",
      "shareId": "",
      "options": {
        "key": "{\\\"comment\\\":\\\"测试\\\"}"
      },
      "isShared": true
    }
  ],
  "nextPageToken": "E8ABEB1C3DB893D16576269017992F57"
}

错误码

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

变更历史

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