查詢集合資訊。 集合的概念包括資料地圖頁面上的專輯、專輯中的子類目等。 通過本介面可以指定集合類型查詢集合資訊。
介面說明
集合包括： ALBUM（專輯集合）， ALBUM_CATEGORY（專輯內的子類目）。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ParentQualifiedName |
string |
否 |
父集合唯一標識 |
Album.1234 |
| NextToken |
string |
否 |
分頁資訊，指定本次讀取的起始點 |
12345 |
| PageSize |
integer |
否 |
每頁顯示的條數，預設為 10 條，最大 100 條。 |
10 |
| Keyword |
string |
否 |
關鍵字。 |
關鍵詞 |
| OrderBy |
string |
否 |
排序欄位名稱。 |
排序欄位 |
| CollectionType |
string |
是 |
查詢的集合類型，取值範圍：
|
ALBUM |
| Creator |
string |
否 |
建立者使用者識別碼。 |
1200759642363000 |
| Administrator |
string |
否 |
集合管理員 ID |
1200759642363000 |
| Follower |
string |
否 |
集合粉絲 ID |
1200759642363000 |
Creator、Administrator、Follower 這三個參數，最多可以設定一個
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回結構 |
||
| RequestId |
string |
請求的 ID。用於定位日誌，排查問題。 |
E25887B7-579C-54A5-9C4F-83A0DE367DDE |
| Data |
object |
返回對象 |
|
| NextToken |
string |
下一頁的 token |
37ae2053d87d380f28ce0dc0853ca51e |
| CollectionList |
array |
數組對象 |
|
| Collection |
返回的集合對象 |
||
| Success |
boolean |
調用是否成功。取值如下：
|
true |
| ErrorCode |
string |
錯誤碼。 |
Invalid.Collection.NotExists |
| ErrorMessage |
string |
錯誤資訊。 |
The specified parameters are invalid. |
| HttpStatusCode |
integer |
HTTP 狀態代碼。 |
200 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "E25887B7-579C-54A5-9C4F-83A0DE367DDE",
"Data": {
"NextToken": "37ae2053d87d380f28ce0dc0853ca51e",
"CollectionList": [
{
"QualifiedName": "album.12334",
"CollectionType": "album",
"Name": "collectionName",
"Comment": "comment",
"OwnerId": "1234444",
"OwnerName": "owner",
"CreateTime": 1668600147617,
"UpdateTime": 1668600148617,
"Level": 1
}
]
},
"Success": true,
"ErrorCode": "Invalid.Collection.NotExists",
"ErrorMessage": "The specified parameters are invalid.",
"HttpStatusCode": 200
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | Invalid.Collection.ParamError | msg: %s | |
| 400 | Invalid.User.NotExist | msg: %s | |
| 400 | Invalid.Collection.QualifiedNameError | msg: %s | |
| 400 | Invalid.Collection.CollectionNotCompatible | msg: %s | |
| 400 | Invalid.Collection.EntityOverflow | msg: %s | |
| 400 | Invalid.Collection.NotExist | msg: %s | |
| 400 | Invalid.Collection.AlreadyExist | msg: %s | |
| 400 | Invalid.Collection.UnsupportedOperation | msg: %s | |
| 400 | InvalidParameter.Meta.Missing | msg: %s | |
| 400 | Forbidden.No.Permission | msg: %s | |
| 400 | InvalidParameter.Meta.IllegalData | msg: %s |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。