使用SearchMedia多維度搜尋媒資資訊-ApsaraVideo for VOD-阿里雲 - ApsaraVideo VOD

本介面用於搜尋影片點播產生的影片、音訊和圖片等媒資資訊，呼叫本介面配合媒資搜尋協定可實現在影片點播中進行指定返回欄位、精確匹配、模糊匹配、多值查詢、範圍查詢、排序欄位等多方式多維度的搜尋查詢。

介面說明

對於支援精確匹配和模糊查詢的欄位，採用其他查詢手段時，其返回的結果都將遵循該欄位所支援的查詢方式，例如，如果一個欄位僅支援模糊查詢，則透過多值查詢方法獲取的結果也是基於模糊匹配返回的。

獲取命中資料筆數限制說明如下：

方法一：分頁遍歷

對於命中的搜尋結果，您可以透過設定分頁參數「PageNo」（頁碼）和「PageSize」（每頁顯示的記錄數）來逐步遍歷最多 5000 筆資料。如果搜尋結果超出了 5000 筆，為了保證有效地遍歷資料，請調整搜尋條件以縮小結果範圍。需要注意的是，此方法無法遍歷完整資料集。若要遍歷更多資料，請參考方法二。
方法二：全量遍歷（限影音搜尋）

此方法適用於影片和音訊內容的搜尋，支援遍歷最多 200 萬筆的全部搜尋結果。如果搜尋結果數量超過 200 萬筆，您應該透過增加更多篩選條件來減少結果數量。使用此方法時，除了「PageNo」和「PageSize」，您還需使用「ScrollToken」參數實現分頁。請注意，每次僅支援向後遍歷最多 100 筆記錄。使用「PageSize」為 20 為例，以下是分頁邏輯：
- 若「PageNo」為 1，您可以查詢接下來的最多 5 頁資料。
- 若「PageNo」為 2，您可以查詢接下來的最多 6 頁資料。

請確保在搜尋時合理設定分頁參數，並根據結果集大小選擇適當的遍歷方法。若您翻頁的資料將大於 1000 筆時，為了您的查詢更方便快捷我們推薦您使用方法 2 來進行資料處理。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

vod:SearchMedia

list

*All Resource

*

無

請求參數

名稱	類型	必填	描述	樣本值
SearchType	string	否	搜尋媒資資料類型。取值範圍： video（預設值）：影片。 audio：音訊。 image：圖片。 attached：輔助媒資。說明當本參數取值為 video 或 audio，且需要遍歷搜尋條件命中的所有資料時，必須設定 ScrollToken 參數。	video
Fields	string	否	搜尋結果中返回的媒資欄位。預設只返回基本媒資欄位，可指定返回更多媒資欄位，請參見使用範例。	Title,CoverURL
Match	string	否	過濾條件。語法規則，請參見搜尋協定語法。	field = value
SortBy	string	否	排序欄位和排序順序。多個使用半形逗號（,）分隔。取值： CreationTime:Desc（預設值）：按建立時間倒序。 CreationTime:Asc：按建立時間升序。說明排序欄位範例：排序欄位。獲取搜尋條件是前 5000 筆的資料時，最多支援三個排序欄位。獲取搜尋條件是所有資料時，僅支援一個排序欄位。	CreationTime:Desc
PageNo	integer	否	目前頁碼。預設值為 1。說明當本參數取值超過 200 時，建議同時設定 ScrollToken 參數。	1
PageSize	integer	否	每頁返回的資料筆數。預設值為 10，最大值為 100。	10
ScrollToken	string	否	翻頁識別碼。長度為 32 個字元。第一次執行搜尋請求時不用設定本參數。搜尋請求命中資料時，伺服器端會返回該參數值，用於記錄目前搜尋資料的位置位址。請記錄返回的參數值，下一次搜尋時按下述要求或建議設定本參數：當 SearchType 參數取值為 video 或 audio，且需要遍歷搜尋條件命中的所有資料時，本參數必須設定。當 PageNo 參數取值超過 200 時，建議設定本參數優化搜尋效能。	24e0fba7188fae707e146esa54****

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。	3E0CEF83-FB09-4E34-BA1451814B03****
Total	integer	滿足搜尋條件的媒資資訊總筆數。	10
ScrollToken	string	翻頁識別碼。	24e0fba7188fae707e146esa54****
MediaList	array<object>	媒資資訊列表。
	array<object>	媒資資訊詳情。
CreationTime	string	媒體建立時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2018-07-19T03:45:25Z
MediaType	string	媒體類型。取值範圍： video：影片。 audio：音訊。 image：圖片。 attached：輔助媒資。	video
MediaId	string	媒體 ID。	a82a2cd7d4e147bbed6c1ee372****
Video	object	影片資訊。
Status	string	狀態。取值： Uploading：上傳中。 UploadFail：上傳失敗。 UploadSucc：上傳完成。 Transcoding：轉碼中。 TranscodeFail：轉碼失敗。 Blocked：屏蔽。 Normal：正常。	UploadSucc
CreationTime	string	視頻資訊建立時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2018-07-19T03:45:25Z
StorageLocation	string	儲存地區。	outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com
CateId	integer	分類別識別碼。	10000123
Tags	string	視頻標籤。	tag1
ModificationTime	string	視頻資訊更新時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2018-07-19T03:48:25Z
MediaSource	string	來源。取值： general：點播上傳。 short_video：短視頻 SDK。 editing：剪輯合成。 live：直播錄製。	general
Description	string	視頻描述。	Alibaba Cloud VOD video description
AppId	string	應用 ID。	app-****
CoverURL	string	封面圖片。	https://example.aliyundoc.com/image01.png
VideoId	string	視頻 ID。	a82a2asdasqadaf3faa0ed6c1ee372****
DownloadSwitch	string	下載開關。只有狀態開啟時才允許離線下載。取值範圍： on（開啟）：初始狀態，允許離線下載。 off（禁用）：禁用離線下載。	on
CateName	string	分類名稱。	video1
TranscodeMode	string	轉碼模式。取值： FastTranscode（普通轉碼）：預設模式，上傳完成即開始轉碼，且轉碼完成才能播放。 NoTranscode（不轉碼即分發）：上傳完成不轉碼，且立即能播放。 AsyncTranscode（上傳即分發並轉碼）：上傳完成即能播放，同時非同步進行轉碼。	FastTranscode
PreprocessStatus	string	預先處理狀態。取值： UnPreprocess：未進行預先處理。 Preprocessing：預先處理中。 PreprocessSucceed：預先處理完成。 PreprocessFailed：預先處理失敗。	Preprocessing
RestoreExpiration	string	媒資解凍有效期間。	2023-03-30T10:14:14Z
RestoreStatus	string	媒資解凍狀態。取值： Processing：解凍中。 Success：解凍成功。 Failed：解凍失敗。	Success
StorageClass	string	媒資儲存類型。取值： Standard：標準。 IA：媒資低頻。 Archive：媒資歸檔。 ColdArchive：媒資冷歸檔。 SourceIA：源檔案低頻。 SourceArchive：源檔案歸檔。 SourceColdArchive：源檔案冷歸檔。 Changing：媒資儲存類型變更中。 SourceChanging：源檔案儲存體類型變更中。	Standard
Size	integer	視頻大小。	123
Duration	number	視頻時間長度。單位：秒。	123
Title	string	視頻標題。	Alibaba Cloud VOD Video Title
SpriteSnapshots	array	雪碧圖列表。
	string	雪碧圖列表。	{“http://example.aliyundoc.com/image02.jpg”}
Snapshots	array	自動截圖列表。
	string	自動截圖列表。	{“http://example.aliyundoc.com/image03.jpg”}
ReferenceId	string	自訂 ID，僅支援小寫字母、大寫字母、數字、橫線、底線，長度 6-64 位元。使用者維度唯一。	123-123
Audio	object	音訊資訊。
Status	string	狀態。取值： Uploading：上傳中。 Normal：正常。 UploadFail：失敗。 Deleted：刪除。	Normal
CreationTime	string	建立時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2018-07-19T03:45:25Z
StorageLocation	string	儲存地區。	outin-aaa*****aa.oss-cn-shanghai.aliyuncs.com
CateId	integer	分類別識別碼。	10000123
Tags	string	標籤。	tag1,tag2
ModificationTime	string	更新時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2018-07-19T03:48:25Z
MediaSource	string	來源。取值： general（點播上傳）：普通上傳。 short_video（短視頻 SDK）：通過短視頻 SDK 上傳檔案至點播，詳細內容請參見短視頻 SDK。 editing（剪輯合成）：通過雲剪輯合成上傳檔案至點播，詳細內容請參見視頻合成。 live（直播錄製）：通過直播錄製上傳檔案至點播。	general
Description	string	描述。	Alibaba Cloud VOD Audio Description
AppId	string	應用 ID。	app-****
CoverURL	string	封面圖片。	http://example.com/image04.jpg
AudioId	string	音頻 ID。	a82a2cd7d4e147bbed6c1ee372****
DownloadSwitch	string	下載開關。只有狀態開啟時才允許離線下載。取值： on（開啟）：初始狀態，允許離線下載。 off（禁用）：禁用離線下載。	on
CateName	string	分類名稱。	cate1
TranscodeMode	string	轉碼模式。取值範圍： FastTranscode（普通轉碼，預設值）：上傳完成即開始轉碼，且轉碼完成才能播放。 NoTranscode（不轉碼即分發）：上傳完成不轉碼，且立即能播放。 AsyncTranscode（上傳即分發並轉碼）：上傳完成即能播放，同時非同步進行轉碼。	FastTranscode
PreprocessStatus	string	預先處理狀態，預先處理完成後的視頻才可用於直播導播。取值： UnPreprocess：未進行預先處理。 Preprocessing：預先處理中。 PreprocessSucceed：預先處理完成。 PreprocessFailed：預先處理失敗。	UnPreprocess
RestoreExpiration	string	媒資解凍有效期間。	2023-03-30T10:14:14Z
RestoreStatus	string	媒資解凍狀態。取值： Processing：解凍中。 Success：解凍成功。 Failed：解凍失敗。	Success
StorageClass	string	媒資儲存類型。取值： Standard：標準。 IA：媒資低頻。 Archive：媒資歸檔。 ColdArchive：媒資冷歸檔。 SourceIA：源檔案低頻。 SourceArchive：源檔案歸檔。 SourceColdArchive：源檔案冷歸檔。 Changing：變更中。	Standard
Size	integer	大小。	123
Duration	number	時間長度。	123
Title	string	標題。	Alibaba Cloud VOD Audio Title
SpriteSnapshots	array	雪碧圖列表。
	string	雪碧圖列表。	{“http://example.aliyundoc.com/image02.jpg”}
Snapshots	array	自動截圖列表。
	string	自動截圖列表。	{“http://example.aliyundoc.com/image03.jpg”}
ReferenceId	string	自訂 ID，僅支援小寫字母、大寫字母、數字、橫線、底線，長度 6-64 位元。使用者維度唯一。	123-123
Image	object	圖片資訊。
StorageLocation	string	儲存地區。	outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com
CreationTime	string	建立時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2018-07-19T03:45:25Z
Status	string	圖片狀態。 Uploading（上傳中）：初始狀態，表示圖片正在上傳。 Normal（正常）：圖片上傳成功。 UploadFail（失敗）：圖片上傳失敗。	Uploading
CateId	integer	分類別識別碼。	1000123
Tags	string	標籤。	tag1
ModificationTime	string	更新時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2018-07-19T03:48:25Z
CateName	string	分類名稱。	cate1
Description	string	描述。	Alibaba Cloud VOD Image Description
AppId	string	應用 ID。	app-****
URL	string	圖片 URL。	https://example.com/****.png
Title	string	標題。	Alibaba Cloud VOD Image Title
ImageId	string	圖片 ID。	11130843741se99wqmoes****
AttachedMedia	object	輔助媒資資訊。
CreationTime	string	建立時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2018-07-19T03:45:25Z
Status	string	狀態。取值： Uploading（上傳中）：初始狀態，表示輔助媒資正在上傳。 Normal（正常）：輔助媒資上傳成功。 UploadFail（失敗）：輔助媒資上傳失敗。	Normal
StorageLocation	string	儲存地區。	outin-bfefbb90a47c11*****7426.oss-cn-shanghai.aliyuncs.com
Tags	string	標籤。	tag1
ModificationTime	string	更新時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2018-07-19T03:48:25Z
MediaId	string	輔助媒資 ID。	a82a2cd7d4e147ba0ed6c1ee372****
BusinessType	string	業務類型。取值： watermark：浮水印。 subtitle：字幕。 material：素材。	watermark
Description	string	描述。	Alibaba Cloud VOD-assisted media asset description
AppId	string	應用 ID。	app-****
URL	string	輔助媒資 URL。	https://example.com/****.png
Title	string	標題。	Alibaba Cloud VOD-assisted media asset Title
Categories	array<object>	分類別識別碼列表。
	object	分類詳情。
ParentId	integer	父節點 ID。	-1
CateName	string	分類名稱。	cate1
CateId	integer	分類別識別碼。	10027394
Level	integer	分類層級。	1
AiData		AI 詳細資訊。
AiRoughData		AI 簡介資料。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "3E0CEF83-FB09-4E34-BA1451814B03****",
  "Total": 10,
  "ScrollToken": "24e0fba7188fae707e146esa54****",
  "MediaList": [
    {
      "CreationTime": "2018-07-19T03:45:25Z",
      "MediaType": "video",
      "MediaId": "a82a2cd7d4e147bbed6c1ee372****",
      "Video": {
        "Status": "UploadSucc",
        "CreationTime": "2018-07-19T03:45:25Z",
        "StorageLocation": "outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com",
        "CateId": 10000123,
        "Tags": "tag1",
        "ModificationTime": "2018-07-19T03:48:25Z",
        "MediaSource": "general",
        "Description": "Alibaba Cloud VOD video description",
        "AppId": "app-****",
        "CoverURL": "https://example.aliyundoc.com/image01.png",
        "VideoId": "a82a2asdasqadaf3faa0ed6c1ee372****",
        "DownloadSwitch": "on",
        "CateName": "video1",
        "TranscodeMode": "FastTranscode",
        "PreprocessStatus": "Preprocessing",
        "RestoreExpiration": "2023-03-30T10:14:14Z",
        "RestoreStatus": "Success",
        "StorageClass": "Standard",
        "Size": 123,
        "Duration": 123,
        "Title": "Alibaba Cloud VOD Video Title",
        "SpriteSnapshots": [
          "{“http://example.aliyundoc.com/image02.jpg”}"
        ],
        "Snapshots": [
          "{“http://example.aliyundoc.com/image03.jpg”}"
        ],
        "ReferenceId": "123-123"
      },
      "Audio": {
        "Status": "Normal",
        "CreationTime": "2018-07-19T03:45:25Z",
        "StorageLocation": "outin-aaa*****aa.oss-cn-shanghai.aliyuncs.com",
        "CateId": 10000123,
        "Tags": "tag1,tag2",
        "ModificationTime": "2018-07-19T03:48:25Z",
        "MediaSource": "general",
        "Description": "Alibaba Cloud VOD Audio Description",
        "AppId": "app-****",
        "CoverURL": "http://example.com/image04.jpg",
        "AudioId": "a82a2cd7d4e147bbed6c1ee372****",
        "DownloadSwitch": "on",
        "CateName": "cate1",
        "TranscodeMode": "FastTranscode",
        "PreprocessStatus": "UnPreprocess",
        "RestoreExpiration": "2023-03-30T10:14:14Z",
        "RestoreStatus": "Success",
        "StorageClass": "Standard",
        "Size": 123,
        "Duration": 123,
        "Title": "Alibaba Cloud VOD Audio Title",
        "SpriteSnapshots": [
          "{“http://example.aliyundoc.com/image02.jpg”}"
        ],
        "Snapshots": [
          "{“http://example.aliyundoc.com/image03.jpg”}"
        ],
        "ReferenceId": "123-123"
      },
      "Image": {
        "StorageLocation": "outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com",
        "CreationTime": "2018-07-19T03:45:25Z",
        "Status": "Uploading",
        "CateId": 1000123,
        "Tags": "tag1",
        "ModificationTime": "2018-07-19T03:48:25Z",
        "CateName": "cate1",
        "Description": "Alibaba Cloud VOD Image Description",
        "AppId": "app-****",
        "URL": "https://example.com/****.png",
        "Title": "Alibaba Cloud VOD Image Title",
        "ImageId": "11130843741se99wqmoes****"
      },
      "AttachedMedia": {
        "CreationTime": "2018-07-19T03:45:25Z",
        "Status": "Normal",
        "StorageLocation": "outin-bfefbb90a47c11*****7426.oss-cn-shanghai.aliyuncs.com",
        "Tags": "tag1",
        "ModificationTime": "2018-07-19T03:48:25Z",
        "MediaId": "a82a2cd7d4e147ba0ed6c1ee372****",
        "BusinessType": "watermark",
        "Description": "Alibaba Cloud VOD-assisted media asset description",
        "AppId": "app-****",
        "URL": "https://example.com/****.png",
        "Title": "Alibaba Cloud VOD-assisted media asset Title",
        "Categories": [
          {
            "ParentId": -1,
            "CateName": "cate1",
            "CateId": 10027394,
            "Level": 1
          }
        ]
      }
    }
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。