ListEntitiesInMetaCollection - 查询数据地图集合中的实体列表

查询数据地图集合中的实体列表,集合支持数据地图类目和数据专辑,实体当前仅支持数据表类型。

接口说明

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

集合对象 Id。

as78d756asd
EntityTypestring

实体类型。

dlf-table
EntityNamestring

实体名称,模糊匹配。

test1
EntityDescriptionstring

添加实体到集合时的描述,模糊匹配,目前仅专辑类型支持。

test
SortBystring

排序字段, 支持

  • Name 名称(默认)
  • CreateTime 实体创建时间
Name
Orderstring

排序方向,支持

  • Asc(默认)
  • Desc
Asc
PageNumberinteger

分页页码,默认为 1。

1
PageSizeinteger

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

10

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

F05080B0-CCE6-5D22-B284-34A51C5D4E28
PagingInfoobject

分页结果对象。

TotalCountinteger

总记录数。

100
PageNumberinteger

页码。

1
PageSizeinteger

页大小。

1
Entitiesarray<object>

集合实体列表。

entitiesobject

集合实体。

Idstring

实体对象的 Id,目前仅支持 Table 资源类型 如果实体已删除,此处返回空。

maxcompute-table:::project_name:[schema_name]:table_name
Typestring

实体类型。

maxcompute-table
Namestring

实体名称。

test_table
Commentstring

实体注释。

test
CreateTimelong

创建时间毫秒级时间戳。

1737078994080
ModifyTimelong

修改时间毫秒级时间戳。

1737078994080
Descriptionstring

添加到集合时的描述信息,目前仅对专辑有效。

test

示例

正常返回示例

JSON格式

{
  "RequestId": "F05080B0-CCE6-5D22-B284-34A51C5D4E28",
  "PagingInfo": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 1,
    "Entities": [
      {
        "Id": "maxcompute-table:::project_name:[schema_name]:table_name",
        "Type": "maxcompute-table",
        "Name": "test_table",
        "Comment": "test",
        "CreateTime": 1737078994080,
        "ModifyTime": 1737078994080,
        "Description": "test"
      }
    ]
  }
}

错误码

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