根據(jù)用戶所給參數(shù),返回所有符合條件的媒資的基礎(chǔ)信息。
接口說明
-
如果 includeFileBasicInfo 字段為真,還會返回源文件基礎(chǔ)信息,例如:時長、文件大小。
-
最多篩選符合條件的前 100 條。
-
所有符合條件的媒資需要精確匹配所有非空字段。支持精確匹配的字段有媒資媒體類型、來源、媒資業(yè)務(wù)類型、分類、資源狀態(tài)。
-
當(dāng)一次性無法返回所有信息時,用戶可使用 nextToken 進行下一輪查詢。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
ice:ListMediaBasicInfos | *全部資源 * |
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
StartTime | string | 否 | utcCreated(創(chuàng)建時間)的開始時間。
| 2020-12-20T12:00:00Z |
EndTime | string | 否 | utcCreated 的結(jié)束時間。
| 2020-12-20T13:00:00Z |
MediaType | string | 否 | 媒資媒體類型。取值范圍:
| video |
BusinessType | string | 否 | 媒資業(yè)務(wù)類型。取值范圍:
| opening |
Source | string | 否 | 來源。
| oss |
Status | string | 否 | 資源狀態(tài)。取值范圍:
| Normal |
NextToken | string | 否 | 用來表示當(dāng)前調(diào)用返回讀取到的位置,空代表數(shù)據(jù)已經(jīng)讀取完畢。 | pSa1SQ0wCe5pzVrQ6mWZEw== |
MaxResults | integer | 否 | 本次請求所返回的最大記錄條數(shù)。 最大值:100,默認值:10 | 5 |
SortBy | string | 否 | 根據(jù) utcCreated 排序, 默認倒序
| desc |
IncludeFileBasicInfo | boolean | 否 | 如果為 true,返回值中包含文件基礎(chǔ)信息。 | true |
MediaId | string | 否 | 媒資 ID | ****019b82e24b37a1c2958dec38**** |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "******B7-7F87-4792-BFE9-63CD21******",
"TotalCount": 4,
"MediaInfos": [
{
"MediaId": "****019b82e24b37a1c2958dec38****",
"MediaBasicInfo": {
"MediaId": "****019b82e24b37a1c2958dec38****",
"InputURL": "https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4",
"MediaType": "video",
"BusinessType": "opening",
"Source": "oss",
"Title": "title標(biāo)題",
"Description": "desc 描述",
"Category": "分類 category",
"MediaTags": "tags,tags2",
"CoverURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>",
"UserData": "userData",
"Snapshots": "[{\"bucket\":\"example-bucket\",\"count\":\"3\",\"iceJobId\":\"******f48f0e4154976b2b8c45******\",\"location\":\"oss-cn-beijing\",\"snapshotRegular\":\"example.jpg\",\"templateId\":\"******e6a6440b29eb60bd7c******\"}]",
"Status": "Normal",
"TranscodeStatus": "Init",
"CreateTime": "2021-01-08T16:52:04Z",
"ModifiedTime": "2021-01-08T16:52:07Z",
"DeletedTime": "2021-01-08T16:52:07Z",
"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": 3049,
"Biz": "ICE",
"UploadSource": "general",
"ReferenceId": "123-123"
},
"FileInfoList": [
{
"FileBasicInfo": {
"FileName": "example.mp4",
"FileStatus": "Normal",
"FileType": "source_file",
"FileSize": "14340962",
"FileUrl": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>",
"Region": "cn-shanghai",
"FormatName": "mov,mp4,m4a,3gp,3g2,mj2",
"Duration": "60.00000",
"Bitrate": "1912.13",
"Width": "1280",
"Height": "720",
"CreateTime": "2021-01-08T16:52:04Z",
"ModifiedTime": "2021-01-08T16:52:07Z"
}
}
]
}
],
"NextToken": "8EqYpQbZ6Eh7+Zz8DxVYoQ==",
"MaxResults": 2
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2021-03-31 | OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |