根据用户所给参数,返回所有符合条件的媒资的基础信息,例如标题、描述;如果includeFileBasicInfo字段为真,也返回源文件基础信息,例如:时长、文件大小,最多筛选符合条件的前100条。所有符合条件的媒资需要精确匹配所有非空字段。支持精确匹配的字段有媒资媒体类型、来源、媒资业务类型、分类、资源状态。当一次性无法返回所有信息时,用户可使用nextToken进行下一轮查询。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListMediaBasicInfos

系统规定参数。取值:ListMediaBasicInfos

StartTime String 2020-12-20T12:00:00Z

utcCreated(创建时间)的开始时间。

- 为开区间(大于开始时间)。

- 日期格式按照ISO8601标准表示,使用UTC时间。格式为:"YYYY-MM-DD'T'hh:mm:ss'Z'"。例如:2017-01-11T12:00:00Z 表示北京时间2017年1月11日20点0分0秒。

EndTime String 2020-12-20T13:00:00Z

utcCreated的结束时间。

- 为闭区间(小于等于结束时间)。

- 日期格式按照ISO8601标准表示,使用UTC时间。格式为:"YYYY-MM-DD'T'hh:mm:ss'Z'"。例如:2017-01-11T12:00:00Z 表示北京时间2017年1月11日20点0分0秒。

MediaType String video

媒资媒体类型。取值范围:

- "image" 图片

- "video" 视频

- "audio" 音频

- "text" 文字

BusinessType String opening

媒资业务类型。取值范围:

- "subtitles" 字幕

- "watermark" 水印

- "opening" 片头/开场

- "ending" 片尾

- "general" 通用

Source String oss

来源,

- "oss" OSS存储

- "vod" 视频点播

- "live" 视频直播

- "general" 其他来源 (默认)

Category String defaultCategory

分类

- 长度不超过64字节。

- UTF8编码。

Status String Normal

资源状态。取值范围:

- Init(初始状态:源文件未就绪)

- Preparing(源文件准备中:比如上传中或者剪辑合成中)

- PrepareFail(源文件准备失败:比如获取源文件信息失败)

- Normal(正常:源文件已就绪)

NextToken String pSa1SQ0wCe5pzVrQ6mWZEw==

用来表示当前调用返回读取到的位置,空代表数据已经读取完毕。

MaxResults Integer 5

本次请求所返回的最大记录条数。

最大值:100,默认值:10

SortBy String desc

根据utcCreated排序, 默认倒序

- "desc" 倒序

- "asc" 正序

IncludeFileBasicInfo Boolean true

如果为true,返回值中包含文件基础信息。

返回数据

名称 类型 示例值 描述
RequestId String ******B7-7F87-4792-BFE9-63CD21******

请求ID

TotalCount Long 4

本次请求条件下的数据总量。

MediaInfos Array of MediaInfo

符合要求的媒资集合

MediaId String ****019b82e24b37a1c2958dec38****

媒资ID

MediaBasicInfo Object

BasicInfo

MediaId String ****019b82e24b37a1c2958dec38****

媒资ID

InputURL String https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4

待注册的媒资在相应系统中的地址

MediaType String video

媒资媒体类型

BusinessType String opening

媒资业务类型

Source String oss

来源

Title String title标题

标题

Description String desc 描述

内容描述

Category String 分类 category

分类

MediaTags String tags,tags2

标签

CoverURL String http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>

封面地址

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 2021-01-08T16:52:04Z

媒资创建时间

ModifiedTime String 2021-01-08T16:52:07Z

媒资修改时间

DeletedTime String 2021-01-08T16:52:07Z

媒资删除时间

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"}]

雪碧图

FileInfoList Array of FileInfo

FileInfos

FileBasicInfo Object

文件基础信息,包含时长,大小等

FileName String example.mp4

文件名

FileStatus String Normal

文件状态

FileType String source_file

文件类型

FileSize String 14340962

文件大小(字节)

FileUrl String http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>

文件oss地址

Region String cn-shanghai

文件存储区域

FormatName String mov,mp4,m4a,3gp,3g2,mj2

封装格式

Duration String 60.00000

时长

Bitrate String 1912.13

码率

Width String 1280

Height String 720

NextToken String 8EqYpQbZ6Eh7+Zz8DxVYoQ==

用来表示当前调用返回读取到的位置,空代表数据已经读取完毕。

MaxResults Integer 2

本次请求所返回的最大记录条数。

示例

请求示例

http(s)://[Endpoint]/?Action=ListMediaBasicInfos
&StartTime=2020-12-20T12:00:00Z
&EndTime=2020-12-20T13:00:00Z
&MediaType=video
&BusinessType=opening
&Source=oss
&Category=defaultCategory
&Status=Normal
&NextToken=pSa1SQ0wCe5pzVrQ6mWZEw==
&MaxResults=5
&SortBy=desc
&IncludeFileBasicInfo=true
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListMediaBasicInfosResponse>
    <RequestId>******B7-7F87-4792-BFE9-63CD21******</RequestId>
    <TotalCount>4</TotalCount>
    <MediaInfos>
        <MediaId>****019b82e24b37a1c2958dec38****</MediaId>
        <MediaBasicInfo>
            <MediaId>****019b82e24b37a1c2958dec38****</MediaId>
            <InputURL>https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4</InputURL>
            <MediaType>video</MediaType>
            <BusinessType>opening</BusinessType>
            <Source>oss</Source>
            <Title>title标题</Title>
            <Description>desc 描述</Description>
            <Category>分类 category</Category>
            <MediaTags>tags,tags2</MediaTags>
            <CoverURL>http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&lt;ExpireTime&gt;&amp;OSSAccessKeyId=&lt;OSSAccessKeyId&gt;&amp;Signature=&lt;Signature&gt;&amp;security-token=&lt;SecurityToken&gt;</CoverURL>
            <UserData>userData</UserData>
            <Snapshots>[{"bucket":"example-bucket","count":"3","iceJobId":"******f48f0e4154976b2b8c45******","location":"oss-cn-beijing","snapshotRegular":"example.jpg","templateId":"******e6a6440b29eb60bd7c******"}]</Snapshots>
            <Status>Normal</Status>
            <TranscodeStatus>Init</TranscodeStatus>
            <CreateTime>2021-01-08T16:52:04Z</CreateTime>
            <ModifiedTime>2021-01-08T16:52:07Z</ModifiedTime>
            <DeletedTime>2021-01-08T16:52:07Z</DeletedTime>
            <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"}]</SpriteImages>
        </MediaBasicInfo>
        <FileInfoList>
            <FileBasicInfo>
                <FileName>example.mp4</FileName>
                <FileStatus>Normal</FileStatus>
                <FileType>source_file</FileType>
                <FileSize>14340962</FileSize>
                <FileUrl>http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4?Expires=&lt;ExpireTime&gt;&amp;OSSAccessKeyId=&lt;OSSAccessKeyId&gt;&amp;Signature=&lt;Signature&gt;&amp;security-token=&lt;SecurityToken&gt;</FileUrl>
                <Region>cn-shanghai</Region>
                <FormatName>mov,mp4,m4a,3gp,3g2,mj2</FormatName>
                <Duration>60.00000</Duration>
                <Bitrate>1912.13</Bitrate>
                <Width>1280</Width>
                <Height>720</Height>
            </FileBasicInfo>
        </FileInfoList>
    </MediaInfos>
    <NextToken>8EqYpQbZ6Eh7+Zz8DxVYoQ==</NextToken>
    <MaxResults>2</MaxResults>
</ListMediaBasicInfosResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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标题",
      "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\"}]"
    },
    "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"
      }
    } ]
  } ],
  "NextToken" : "8EqYpQbZ6Eh7+Zz8DxVYoQ==",
  "MaxResults" : 2
}

错误码

访问错误中心查看更多错误码。

访问错误中心查看更多错误码。