ListCatalogs - 查询数据地图数据目录列表

查询数据地图下的数据目录列表,当前支持dlfstarrocks类型。 dlf类型返回支持的所有数据目录列表,starrocks类型返回特定实例下的数据目录列表。

接口说明

  1. 需要购买 DataWorks 基础版及以上版本才能使用。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
ParentMetaEntityIdstring

父层级实体 ID,可参考元数据实体相关概念说明

当前支持 dlf 与 starrocks 类型。

  • 对于 dlf 类型,支持查询所有目录列表,ParentMetaEntityId格式为 dlf

  • 对于 starrocks 类型,支持查询特定实例下的数据目录列表,ParentMetaEntityId格式为 starrocks:(instance_id|encoded_jdbc_url)

说明 其中
instance_id: 实例 ID,对应数据源以实例模式注册时需要提供
encoded_jdbc_url: JDBC 连接串的 URLEncode 编码,对应数据源以连接串方式注册时需要提供
dlf
Namestring

名称,模糊匹配。

abc
Commentstring

注释,分词匹配。

this is a comment
Typesarray

类型,精确匹配,为空时查询所有类型。

string

数据目录类型。

HIVE
SortBystring

排序字段,默认为 CreateTime,枚举值,当前支持

  • CreateTime 创建时间
  • ModifyTime 修改时间
  • Name 名称
  • Type 类型
CreateTime
Orderstring

排序方向,默认为 Asc,枚举值,当前支持

  • Asc 升序
  • Desc 降序
Asc
PageNumberinteger

分页页码,默认为 1。

1
PageSizeinteger

分页大小,默认为 10,最大为 100。

10

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

317CD7D0-AB36-XXXXXX
Successboolean

请求是否成功。

true
PagingInfoobject

分页结果。

TotalCountlong

总条数。

1
PageNumberinteger

页码。

1
PageSizeinteger

分页大小。

10
Catalogsarray

数据目录列表。

CatalogListCatalog

数据目录详情。

示例

正常返回示例

JSON格式

{
  "RequestId": "317CD7D0-AB36-XXXXXX",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "Catalogs": [
      {
        "Id": "dlf-catalog::catalog_id",
        "Name": "default_catalog",
        "Comment": "this is a comment",
        "Type": "Internal",
        "CreateTime": 1722073854000,
        "ModifyTime": 1722073854000,
        "ParentMetaEntityId": "dlf"
      }
    ]
  }
}

错误码

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