查询数据地图集合列表,支持查询数据地图类目以及数据专辑两种类型。
接口说明
- 需要购买 DataWorks 专业版及以上版本才能使用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Type | string | 是 | 集合类型,可枚举,取值为
| Category |
ParentId | string | 否 | 父节点集合对象 ID。 | as78d756asd |
Name | string | 否 | 集合名称,模糊匹配。 | test |
Description | string | 否 | 集合描述,模糊匹配。 | 测试集合 |
CreateUser | string | 否 | 创建者用户 ID,专辑类型有效,默认为当前用户 ID。 | 123456 |
Administrator | string | 否 | 集合管理员 ID,专辑类型有效,默认为当前用户 ID。 | 12345 |
SortBy | string | 否 | 排序字段, 支持
| Name |
Order | string | 否 | 排序方向,支持
| Asc |
PageNumber | integer | 否 | 分页页码,默认为 1。 | 1 |
PageSize | integer | 否 | 分页大小,默认为 10,最大为 100。 | 10 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "E25887B7-579C-54A5-9C4F-83A0DE367DDE",
"Data": {
"TotalCount": 10,
"PageNumber": 1,
"PageSize": 10,
"MetaCollections": [
{
"Name": "test_category",
"Id": "7a65sd7aasd",
"ParentId": "as78d756asd",
"Description": "测试类目",
"Type": "Category",
"CreateUser": 456789,
"CreateTime": 1668568601000,
"ModifyTime": 1668568601000,
"Administrators": [
765432
]
}
]
}
}
错误码
访问错误中心查看更多错误码。