调用ListSchemas API查询数据地图的数据库或项目模式列表-大数据开发治理平台 DataWorks-阿里云-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

查询数据地图中给定数据库或maxcompute项目下的模式列表，当前支持maxcompute和holo类型。

接口说明

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:ListSchemas

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
ParentMetaEntityId	string	是	父层级实体 ID，可参考元数据实体相关概念说明，其中 holo 类型的`ParentMetaEntityId`可参考 ListDatabases 接口返回结果。 `ParentMetaEntityId`格式为`${EntityType}:${实例 ID 或转义后的 URL}:${数据目录标识}:${数据库名称}`，对于不存在的层级空字符占位。说明对于 maxcompute 类型，实例 id 层级使用空字符占位，数据库名称为 maxcompute 项目名称，要求该项目已开启三层模型。几种常用类型 ParentMetaEntityId 格式参考如下 `maxcompute-project:::project_name` （要求该项目已开启三层模型） `holo-database:instance_id::database_name` 说明其中 `instance_id`: holo 实例 ID `database_name`: 数据库名称 `project_name`: maxcompute 项目名	maxcompute-project:::project_name
Name	string	否	名称，模糊匹配。	abc
Comment	string	否	注释，模糊匹配。	test comment
Types	array	否	类型，精确匹配，为空时查询所有类型。
	string	否	模式类型。	MANAGED
SortBy	string	否	排序字段，默认为 CreateTime，枚举值，当前支持： CreateTime：创建时间。 ModifyTime：修改时间。 Name：名称。 Type：类型。	CreateTime
Order	string	否	排序方向，默认为 Asc，枚举值，当前支持： Asc：升序。 Desc：降序。	Asc
PageNumber	integer	否	分页页码，默认为 1。	1
PageSize	integer	否	分页大小，默认为 10，最大为 100。	10

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	235BBA5E-3428-XXXXXX
Success	boolean	请求是否成功。	true
PagingInfo	object	分页信息。
TotalCount	integer	总条数。	1
PageNumber	integer	页码。	1
PageSize	integer	分页大小。	10
Schemas	array	数据库 schema 列表。
	Schema	数据库 schema。

示例

正常返回示例

JSON格式

{
  "RequestId": "235BBA5E-3428-XXXXXX",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "Schemas": [
      {
        "Id": "maxcompute-schema:123456XXX::test_project:default\nholo-schema:h-abc123xxx::test_db:test_schema",
        "Name": "test_db",
        "Comment": "test comment",
        "Type": "MANAGED",
        "ParentMetaEntityId": "maxcompute-project:123456XXX::test_project\nholo-database:h-abc123xxx::test_db",
        "CreateTime": 1736852168000,
        "ModifyTime": 1736852168000
      }
    ]
  }
}

错误码

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

变更历史

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