查詢資料地圖集合列表,支援查詢資料地圖類目以及資料專輯兩種類型。
介面說明
需要購買 DataWorks 專業版及以上版本才能使用。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Type |
string |
是 |
集合類型,可枚舉,取值為
|
Category |
| ParentId |
string |
否 |
父節點集合物件識別碼。 |
as78d756asd |
| Name |
string |
否 |
集合名稱,模糊比對。 |
test |
| Description |
string |
否 |
集合描述,模糊比對。 |
測試集合 |
| CreateUser |
string |
否 |
建立者使用者識別碼,專輯類型有效,預設為目前使用者 ID。 |
123456 |
| Administrator |
string |
否 |
集合管理員 ID,專輯類型有效,預設為目前使用者 ID。 |
12345 |
| SortBy |
string |
否 |
排序欄位, 支援
|
Name |
| Order |
string |
否 |
排序方向,支援
|
Asc |
| PageNumber |
integer |
否 |
分頁頁碼,預設為 1。 |
1 |
| PageSize |
integer |
否 |
分頁大小,預設為 10,最大為 100。 |
10 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回結果。 |
||
| RequestId |
string |
請求 ID。 |
E25887B7-XXXX-54A5-9C4F-83A0DE367DDE |
| Data |
object |
分頁結果對象。 |
|
| TotalCount |
integer |
總記錄數。 |
10 |
| PageNumber |
integer |
頁碼。 |
1 |
| PageSize |
integer |
頁大小。 |
10 |
| MetaCollections |
array<object> |
集合列表。 |
|
|
object |
集合對象。 |
||
| Name |
string |
集合對象名稱。 |
test_category |
| Id |
string |
集合對象名稱。 |
7a65sd7aasd |
| ParentId |
string |
父節點集合對象 Id,可為空白。 |
as78d756asd |
| Description |
string |
集合對象描述。 |
測試類別目 |
| Type |
string |
集合類型,可枚舉,取值為
|
Category |
| CreateUser |
string |
建立者使用者識別碼。 |
456789 |
| CreateTime |
integer |
建立時間毫秒級時間戳記。 |
1668568601000 |
| ModifyTime |
integer |
修改時間毫秒級時間戳記。 |
1668568601000 |
| Administrators |
array |
管理使用者 ID 列表,僅專輯類型支援, 需要為同租戶下使用者,可設定多個。 |
|
|
string |
管理使用者 ID。 |
765432 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "E25887B7-XXXX-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"
]
}
]
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。