查询数据地图集合中的实体列表,集合支持数据地图类目和数据专辑,实体当前仅支持数据表类型。
接口说明
需要购买 DataWorks 专业版及以上版本才能使用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Id |
string |
是 |
集合对象 Id。 |
as78d756asd |
| EntityType |
string |
否 |
实体类型。 |
dlf-table |
| EntityName |
string |
否 |
实体名称,模糊匹配。 |
test1 |
| EntityDescription |
string |
否 |
添加实体到集合时的描述,模糊匹配,目前仅专辑类型支持。 |
test |
| SortBy |
string |
否 |
排序字段, 支持
|
Name |
| Order |
string |
否 |
排序方向,支持
|
Asc |
| PageNumber |
integer |
否 |
分页页码,默认为 1。 |
1 |
| PageSize |
integer |
否 |
分页大小,默认为 10,最大为 100。 |
10 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结果。 |
||
| RequestId |
string |
请求 ID。 |
F05080B0-CCE6-5D22-B284-34A51C5D4E28 |
| PagingInfo |
object |
分页结果对象。 |
|
| TotalCount |
integer |
总记录数。 |
100 |
| PageNumber |
integer |
页码。 |
1 |
| PageSize |
integer |
页大小。 |
1 |
| Entities |
array<object> |
集合实体列表。 |
|
|
object |
集合实体。 |
||
| Id |
string |
实体对象的 Id,目前仅支持 Table 资源类型 如果实体已删除,此处返回空。 |
maxcompute-table:::project_name:[schema_name]:table_name |
| Type |
string |
实体类型。 |
maxcompute-table |
| Name |
string |
实体名称。 |
test_table |
| Comment |
string |
实体注释。 |
test |
| CreateTime |
integer |
创建时间毫秒级时间戳。 |
1737078994080 |
| ModifyTime |
integer |
修改时间毫秒级时间戳。 |
1737078994080 |
| Description |
string |
添加到集合时的描述信息,目前仅对专辑有效。 |
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"
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。