調用SearchMedia搜尋媒資資訊-智能媒體服務-阿里雲 - Intelligent Media Services

根據使用者所提供參數，返回符合條件的媒資資訊。

介面說明

阿里雲智慧媒體服務智慧媒資搜尋功能使用或問題諮詢等，請搜尋釘釘群（30415005038）加入智慧媒體服務多模檢索客戶答疑群聯繫我們。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ice:SearchMedia

get

*全部資源。

*

無

請求參數

名稱	類型	必填	描述	樣本值
Match	string	否	過濾條件。	title = '中國' and utcCreate = ['1693367158561','1693367158562']
SortBy	string	否	排序欄位和排序順序。多個使用英文逗號（,）分隔。	utcCreate:Desc
PageNo	integer	否	目前頁碼。預設值為 1。	1
PageSize	integer	否	每頁返回的資料筆數。預設值為 10，最大值為 50。	20
EntityId	string	否	實體 ID。	2d3bf1e35a1e42b5ab338d701efa****
ScrollToken	string	否	翻頁識別碼。32 欄位。第一次執行搜尋請求時不用設定本參數。搜尋請求命中資料時，伺服器端會返回該參數值，用於記錄目前搜尋資料的位置位址。請記錄返回的參數值，下一次搜尋時按下述要求或建議設定本參數：需要遍歷搜尋條件命中的所有資料時，本參數必須設定。當 PageNo 參數取值超過 200 時，建議設定本參數最佳化搜尋效能。只能向後翻頁，最大翻頁距離為 1000 媒資。	F8C4F642184DBDA5D93907A70AAE****
SearchLibName	string	否	搜尋庫。	test-1
CustomFilters	string	否	自訂過濾。JSON 字串；支援欄位 Int 型 intField1、字串型 strField1、strField2；同一個欄位最多可選擇一種比對，不同欄位過濾時為且關係。精準，如 {"intField1":12,"strField1":"abc"} 多值，如 {"intField1":[12,13],"strField1":["abc","cd"]} 範圍，如 {"intField1":{"gte":12,"lte":13}}	{"intField1":{"gte":12,"lte":13},"strField2":["cd","de"],"strField1":"abc"}

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response。
RequestId	string	請求 ID。	6F61C357-ACC0-57FB-876E-D5879533****
Success	string	是否成功。	True
Code	string	返回碼。	200
MediaInfoList	array<object>	符合要求的媒資集合。
	array<object>	媒資資訊清單。
MediaId	string	媒資 ID。	3b187b3620c8490886cfc2a9578c****
MediaBasicInfo	object	媒資基礎資訊。
MediaId	string	媒資 ID。	132bd600fc3c71ec99476732a78f****
InputURL	string	待註冊的媒資在相應系統中的位址。	oss://clipres/longvideo/material/voice/prod/20220418/07d7c799f6054dc3bbef250854cf8498165024814****
MediaType	string	媒資媒體類型。	video
BusinessType	string	媒資業務類型。	opening
Source	string	來源。	oss
Title	string	標題。	智慧橫向轉直向
Description	string	內容描述。	對這個影片進行轉碼處理了
Category	string	分類。	image
MediaTags	string	標籤。	tags,tags2
CoverURL	string	封面位址。	https://dtlive-bj.oss-cn-beijing.aliyuncs.com/cover/e694372e-4f5b-4821-ae09-efd064f2****_large_cover_url.jpg
UserData	string	使用者資料。	userData
Snapshots	string	截圖。	[{"bucket":"example-bucket","count":"3","iceJobId":"****f48f0e4154976b2b8c45**","location":"oss-cn-beijing","snapshotRegular":"example.jpg","templateId":"**e6a6440b29eb60bd7c****"}]
Status	string	資源狀態。	Normal
TranscodeStatus	string	轉碼狀態。	Init
CreateTime	string	媒資建立時間。時間格式為 ISO 8601，使用 UTC 時間（以 Z 結尾）。	2020-12-01T19:48Z
ModifiedTime	string	媒資修改時間。時間格式為 ISO 8601，使用 UTC 時間（以 Z 結尾）。	2020-12-01T19:48Z
DeletedTime	string	媒資刪除時間。時間格式為 ISO 8601，使用 UTC 時間（以 Z 結尾）。	2020-12-01T19:48Z
SpriteImages	string	雪碧圖。	[{"bucket":"example-bucket","count":"32","iceJobId":"****83ec44d58b2069def2e**","location":"oss-cn-shanghai","snapshotRegular":"example/example-{Count}.jpg","spriteRegular":"example/example-{TileCount}.jpg","templateId":"**e438b14ff39293eaec25****","tileCount":"1"}]
CateId	integer	分類 ID。	44
Biz	string	媒資所屬業務。	IMS
UploadSource	string	上傳資源。	general
CateName	string	分類名稱。	子分類1
ReferenceId	string	自訂 ID，僅支援小寫字母、大寫字母、數字、橫線、底線，長度 6-64 位。使用者維度唯一。	123-123
Namespace	string	命名空間。	name-1
VisionDescription	string	視覺描述。	足球進球
StreamStatus	string	串流狀態。	Active
FileInfoList	array<object>	FileInfos。
	array<object>	fileinfo 清單。
FileBasicInfo	object	檔案基礎資訊，包含時長，大小等。
FileName	string	檔案名稱。	164265080291300080527050.wav
FileStatus	string	檔案狀態。	Normal
FileType	string	檔案類型。	source_file
FileSize	string	檔案大小（位元組）。	324784
FileUrl	string	檔案 OSS 位址。	https://outin-d3f4681ddfd911ec99a600163e1403e7.oss-cn-shanghai.aliyuncs.com/sv/23d5cdd1-18180984899/23d5cdd1-1818098****.mp4
Region	string	檔案儲存區域。	cn-beijing
FormatName	string	封裝格式。	mov,mp4,m4a,3gp,3g2,mj2
Duration	string	時長。	60.00000
Bitrate	string	位元率。	1912.13
Width	string	寬。	1920
Height	string	高。	480
CreateTime	string	建立時間。時間格式為 ISO 8601，使用 UTC 時間（以 Z 結尾）。	2022-05-30T02:02:17Z
ModifiedTime	string	最後修改時間。時間格式為 ISO 8601，使用 UTC 時間（以 Z 結尾）。	2021-12-10T12:19Z
ImagesInput	string	圖片集資訊。	{}
AiData	object	AI 詳細資訊。
AiLabelInfo	array<object>	AI 標籤資訊列表。
	array<object>	AI 標籤資訊。
FaceId	string	人臉 ID。	5FE19530C7A422197535FE74F5DB****
LabelType	string	標籤類型。	物體
Source	string	來源。	vision
Category	string	分類。	交通工具
LabelName	string	實體名稱。	車
LabelId	string	實體 ID。	10310250338
Occurrences	array<object>	片段列表。
	array<object>	片段。
Score	number	評分。	0.75287705
Image	string	最佳人臉圖片的 base64 編碼。	99C64F6287
TableBatchSeqId	string	向量表序列 ID。	85010D1
clipId	string	片段 ID。	5FE19530C7A422197535FE74F5DB****
From	number	片段起始時間。	1.4
To	number	片段結束時間。	2.5
FinegrainName	string	實體的細粒度名稱。	車
FinegrainId	string	實體的細粒度 ID。	10310250338
Content	string	文字內容。	皮皮
Tracks	array<object>	track 序列。
	object	序列。
Size	number	人臉 bbox 框的面積。	50.2
Position	string	bbox 框位置座標。	468.0;67.0;615.0;267.0
Timestamp	number	track 的時間戳記。	1.4
AsrInfo	array<object>	語音資訊列表。
	object	語音資訊。
From	number	片段起始時間。	1.4
To	number	片段結束時間。	2.5
ClipId	string	片段 ID。	5FE19530C7A422197535FE74F5DB****
Content	string	文字內容。	我是皮皮
Timestamp	number	片段時間戳記。	1.4
OcrInfo	array<object>	字幕資訊列表。
	object	字幕資訊。
From	number	片段起始時間。	1.4
To	number	片段結束時間。	2.5
ClipId	string	片段 ID。	5FE19530C7A422197535FE74F5DB****
Content	string	文字內容。	我是皮皮
Timestamp	number	片段時間戳記。	1.4
AiRoughData	object	AI 簡介資料。
SaveType	string	儲存類型。	TEXT
Status	string	資料狀態。	SaveSuccess
AiJobId	string	AI 任務 ID。	cd35b0b0025f71edbfcb472190a9****
Result	string	AI 結果。	http://xxxx.json
AiCategory	string	電視劇。	影片 AI 分類
IndexStatusList	array<object>	索引狀態列表。
	object	索引狀態。
IndexType	string	索引類別。取值： mm：大型模型。 face：人臉。 aiLabel：智慧標籤。	mm
IndexStatus	string	索引狀態。取值： Running：執行中。 Fail：失敗。 Success: 成功。	Success
CustomFields	string	自訂篩選參數。	{\"intField1\":12,\"strField1\":\"abc\"}
ScrollToken	string	翻頁標記。	F8C4F642184DBDA5D93907A70AAE****
Total	integer	符合條件的媒資總數。	163

樣本

正常返回樣本

JSON格式

{
  "RequestId": "6F61C357-ACC0-57FB-876E-D5879533****",
  "Success": "True",
  "Code": "200",
  "MediaInfoList": [
    {
      "MediaId": "3b187b3620c8490886cfc2a9578c****",
      "MediaBasicInfo": {
        "MediaId": "132bd600fc3c71ec99476732a78f****",
        "InputURL": "oss://clipres/longvideo/material/voice/prod/20220418/07d7c799f6054dc3bbef250854cf8498165024814****",
        "MediaType": "video",
        "BusinessType": "opening",
        "Source": "oss",
        "Title": "Smart landscape-to-portrait conversion",
        "Description": "對這個影片進行轉碼處理了",
        "Category": "image",
        "MediaTags": "tags,tags2\n",
        "CoverURL": "https://dtlive-bj.oss-cn-beijing.aliyuncs.com/cover/e694372e-4f5b-4821-ae09-efd064f2****_large_cover_url.jpg",
        "UserData": "userData",
        "Snapshots": "[{\"bucket\":\"example-bucket\",\"count\":\"3\",\"iceJobId\":\"******f48f0e4154976b2b8c45******\",\"location\":\"oss-cn-beijing\",\"snapshotRegular\":\"example.jpg\",\"templateId\":\"******e6a6440b29eb60bd7c******\"}]",
        "Status": "Normal",
        "TranscodeStatus": "Init",
        "CreateTime": "2020-12-01T19:48Z",
        "ModifiedTime": "2020-12-01T19:48Z\n",
        "DeletedTime": "2020-12-01T19:48Z\n",
        "SpriteImages": "[{\"bucket\":\"example-bucket\",\"count\":\"32\",\"iceJobId\":\"******83ec44d58b2069def2e******\",\"location\":\"oss-cn-shanghai\",\"snapshotRegular\":\"example/example-{Count}.jpg\",\"spriteRegular\":\"example/example-{TileCount}.jpg\",\"templateId\":\"******e438b14ff39293eaec25******\",\"tileCount\":\"1\"}]",
        "CateId": 44,
        "Biz": "IMS",
        "UploadSource": "general",
        "CateName": "Subcategory 1",
        "ReferenceId": "123-123",
        "Namespace": "name-1",
        "VisionDescription": "足球進球",
        "StreamStatus": "Active"
      },
      "FileInfoList": [
        {
          "FileBasicInfo": {
            "FileName": "164265080291300080527050.wav",
            "FileStatus": "Normal",
            "FileType": "source_file",
            "FileSize": "324784",
            "FileUrl": "https://outin-d3f4681ddfd911ec99a600163e1403e7.oss-cn-shanghai.aliyuncs.com/sv/23d5cdd1-18180984899/23d5cdd1-1818098****.mp4",
            "Region": "cn-beijing",
            "FormatName": "mov,mp4,m4a,3gp,3g2,mj2",
            "Duration": "60.00000\n",
            "Bitrate": "1912.13\n",
            "Width": "1920",
            "Height": "480",
            "CreateTime": "2022-05-30T02:02:17Z",
            "ModifiedTime": "2021-12-10T12:19Z",
            "ImagesInput": "{}"
          }
        }
      ],
      "AiData": {
        "AiLabelInfo": [
          {
            "FaceId": "5FE19530C7A422197535FE74F5DB****",
            "LabelType": "Object",
            "Source": "vision",
            "Category": "Vehicle",
            "LabelName": "Car",
            "LabelId": "10310250338",
            "Occurrences": [
              {
                "Score": 0.75287705,
                "Image": "99C64F6287",
                "TableBatchSeqId": "85010D1",
                "clipId": "5FE19530C7A422197535FE74F5DB****",
                "From": 1.4,
                "To": 2.5,
                "FinegrainName": "Car",
                "FinegrainId": "10310250338",
                "Content": "Pipi",
                "Tracks": [
                  {
                    "Size": 50.2,
                    "Position": "468.0;67.0;615.0;267.0",
                    "Timestamp": 1.4
                  }
                ]
              }
            ]
          }
        ],
        "AsrInfo": [
          {
            "From": 1.4,
            "To": 2.5,
            "ClipId": "5FE19530C7A422197535FE74F5DB****",
            "Content": "I am Pipi.",
            "Timestamp": 1.4
          }
        ],
        "OcrInfo": [
          {
            "From": 1.4,
            "To": 2.5,
            "ClipId": "5FE19530C7A422197535FE74F5DB****",
            "Content": "我是皮皮",
            "Timestamp": 1.4
          }
        ]
      },
      "AiRoughData": {
        "SaveType": "TEXT",
        "Status": "SaveSuccess",
        "AiJobId": "cd35b0b0025f71edbfcb472190a9****",
        "Result": "http://xxxx.json",
        "AiCategory": "影片 AI 分類"
      },
      "IndexStatusList": [
        {
          "IndexType": "mm",
          "IndexStatus": "Success"
        }
      ],
      "CustomFields": "{\\\"intField1\\\":12,\\\"strField1\\\":\\\"abc\\\"}"
    }
  ],
  "ScrollToken": "F8C4F642184DBDA5D93907A70AAE****",
  "Total": 163
}

錯誤碼

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

變更歷史

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