搜索視頻
更新時間 2025-04-16 10:39:50
最近更新時間: 2025-04-16 10:39:50
分享文章
通過本接口查詢媒體庫的視頻條目。
接口功能介紹
用戶可通過本接口查詢媒體庫的視頻條目。
接口約束
本接口的單用戶QPS限制為20次/秒。超過限制，API調用會被限流，這可能會影響您的業務，請合理調用。
URI
POST /video/search
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| name | 否 | String | 視頻的名稱，模糊匹配。 | "" | |
| regionCode | 否 | Array of Strings | 區域編碼列表，需要查詢的視頻的區域，不傳則為全部區域。 | ["xs-cn-shanghai-1"] | |
| categoryId | 否 | Integer | 視頻所屬分類ID | 1000000600035 | |
| pageSize | 否 | Integer | 每頁的數量，當 pageSize 與 pageIndex 為空時，表示不分頁。 | 10 | |
| pageIndex | 否 | Integer | 頁碼，由0開始，當 pageSize 與 pageIndex 為空時，表示不分頁。 | 0 |
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| code | 是 | Integer | 本次請求的結果碼。 | 0 | |
| message | 是 | String | 錯誤文本信息，執行成功時，為空字符串。 | "" | |
| data | 是 | Array of Objects | 視頻信息列表，即使返回的是一個視頻，均會放入列表中。 | -- | data |
表data
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| videoId | 是 | String | 視頻ID | 34c71dba-f280-4f5e-a05f-f4daed837fef | |
| name | 是 | String | 視頻名稱 | 平凡的世界 | |
| remark | 是 | String | 視頻簡介 | 講述了在面對現實壓力和人生抉擇時，兄弟倆依舊堅守最初夢想和對愛情執著的追求的故事 | |
| tags | 是 | Array of Strings | 視頻標簽 | 勵志片 | |
| category | 是 | Object | 視頻分類信息。 | -- | category |
| region | 是 | Object | 區域信息 | -- | region |
| videoUrl | 是 | String | 源視頻url | //example.gdoss.xstore.daliqc.cn/xxx/xxx.mp4 | |
| status | 是 | String | 視頻審核結果：UNAUDITED(未審核)/PASSED(審核通過)/NOT_PASSED(審核不通過)。 | UNAUDITED | |
| uploadStatus | 是 | String | 視頻上傳狀態：UPLOAD_SUCCESS(上傳成功)/UPLOADING(上傳中)/UPLOAD_FAILED(上傳失敗)。 | UPLOAD_SUCCESS | |
| coverUrl | 是 | String | 封面地址，可能為空。 | //example.gdoss.xstore.daliqc.cn/xxx/xxx.jpg | |
| metaData | 是 | 視頻的元數據信息 | -- | metaData | |
| createTime | 是 | String | 視頻創建時間 | 2019-06-10 14:30:50 |
表 category
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| id | 是 | Integer | 分類ID。 | 1000600001 | |
| name | 是 | String | 分類名稱。 | 國產電影 | |
| parentId | 是 | Integer | 關聯的parentId，如為0代表未分類，如為非0則代表本條目為parentId管理視頻條目的子條目。 | 1000600001 | |
| child | 否 | Object | 下級視頻分類條目，支持嵌套。目前同一視頻條目僅支持最多三級分類，即父-子-子。 | -- | child |
表 child
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| id | 是 | Integer | 分類ID。 | 1000600001 | |
| name | 是 | String | 分類名稱。 | 國產電影 | |
| parentId | 是 | Integer | 關聯的parentId，如為0代表未分類，如為非0則代表本條目為parentId管理視頻條目的子條目。 | 1000600001 | |
| child | 否 | Object | 下級視頻分類條目，支持嵌套。目前同一視頻條目僅支持最多三級分類，即父-子-子。 | -- | child |
表 region
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| name | 是 | String | 資源池名稱 | 上海資源池1區 | |
| code | 是 | String | 資源池編碼 | xs-cn-shanghai-1 |
表metaData
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| 略 | 否 | String | 視頻具體的metadata信息 | 以實際輸出為準，因數據較長，此處略。 |
請求示例
{
"name": "",
"regionCode": ["xs-cn-guangzhou-1", "xs-cn-shanghai-1"],
"categoryId"：10000612,
"pageSize": 10,
"pageIndex": 0
}
響應示例
{
"code": 0,
"message": "",
"data": [
{
"videoId": "34c71dba-f280-4f5e-a05f-f4daed837fef",
"name": "我的電影",
"remark": "",
"tags": ["愛情片", "動作片"],
"category":{
"id":1000600045,
"name":"電影",
"parentId":0,
"child":{
"id":1000676,
"name":"武俠",
"parentId":1000600045
"child":{
"id":100060091,
"name":"成龍",
"parentId":1000676
}
}
},
"region": {
"name": "華南1",
"code": "xs-cn-guangzhou-1"
},
"videoUrl": "",
"status": "UNAUDITED",
"uploadStatus": "UPLOAD_SUCCESS",
"coverUrl": "",
"metaData": {
"(此處略)"
},
"createTime": "2019-06-10 14:30:50"
},
]
}
狀態碼
| Http 狀態碼 | 狀態碼信息 | 狀態碼描述 |
|---|---|---|
| 0 | 表示業務成功 | 表示業務成功 |
| 400 | 請求參數有誤 | 請求參數有誤 |
| 403 | 用戶鑒權失敗，用戶無操作權限 | 用戶鑒權失敗，用戶無操作權限 |
| 404 | 請求的資源不存在，輸入錯誤的URL | 請求的資源不存在，輸入錯誤的URL |
| 500 | 業務執行異常 | 業務執行異常 |
錯誤碼
OpenAPI錯誤碼請參考 錯誤碼說明。
