全部产品

列出符合条件的媒资基础信息

本文为您介绍列出符合条件的媒资基础信息API的请求参数与示例。

描述

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

请求参数

字段名称

类型

必填项

示例值

描述

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

video

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

- "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(正常:源文件已就绪)

SortBy

String

desc

根据utcCreated排序, 默认倒序

- "desc" 倒序

- "asc" 正序

NextToken

String

pSa1SQ0wCe5pzVrQ6mWZEw==

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

MaxResults

Integer

5

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

最大值:100,默认值:10

IncludeFileBasicInfo

Boolean

否,默认false。

true

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

返回参数

字段名称

类型

描述

RequestId

String

请求ID

MediaInfos

MediaInfo[]

媒资信息列表。

默认仅包含媒资基础信息MediaBasicInfo

IncludeFileBasicInfo字段为真时,也包含源文件的文件基础信息FileBasicInfo

NextToken

String

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

MaxResults

Integer

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

TotalCount

Integer

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

请求示例

https://ice.cn-shanghai.aliyuncs.com/?Action=ListMediaBasicInfos
&MediaType=video
&MaxResults=2
&IncludeFileBasicInfo=true
&<公共参数>

返回示例

{
  "NextToken": "8EqYpQbZ6Eh7+Zz8DxVYoQ==",
  "RequestId": "B45F83B7-7F87-4792-BFE9-63CD2137CAF0",
  "MaxResults": 2,
  "TotalCount": 4,
  "MediaInfos": [
    {
      "MediaId": "****019b82e24b37a1c2958dec38****",
      "FileInfoList": [
        {
          "FileBasicInfo": {
            "FileUrl": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>",
            "FileStatus": "Normal",
            "FileType": "source_file",
            "FileName": "example.mp4",
            "FormatName": "mov,mp4,m4a,3gp,3g2,mj2",
            "Region": "cn-shanghai",
            "Height": "1080",
            "Duration": "10.040000",
            "Width": "1920",
            "Bitrate": "270112.12",
            "FileSize": "338990717"
          }
        }
      ],
      "MediaBasicInfo": {
        "Status": "Normal",
        "Category": "分类 category",
        "Description": "desc 描述",
        "UserData": "userData",
        "CreateTime": "2021-01-08T16:52:04Z",
        "BusinessType": "opening",
        "Title": "title标题",
        "InputURL": "https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4",
        "TranscodeStatus": "Init",
        "Source": "oss",
        "ModifiedTime": "2021-01-08T16:52:07Z",
        "MediaId": "****019b82e24b37a1c2958dec38****",
        "MediaType": "video",
        "CoverURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>",
        "MediaTags": "tags,tags2"
      }
    },
    {
      "MediaId": "****b9dbbf674ee3af6f8e8ff868****",
      "FileInfoList": [
        {
          "FileBasicInfo": {
            "FileUrl": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>",
            "FileStatus": "Normal",
            "FileType": "source_file",
            "FileName": "example2.mp4",
            "FormatName": "mov,mp4,m4a,3gp,3g2,mj2",
            "Region": "cn-shanghai",
            "Height": "720",
            "Duration": "60.000000",
            "Width": "1280",
            "Bitrate": "1912.13",
            "FileSize": "14340962"
          }
        }
      ],
      "MediaBasicInfo": {
        "Status": "Normal",
        "ModifiedTime": "2021-01-04T09:55:40Z",
        "MediaId": "****b9dbbf674ee3af6f8e8ff868****",
        "CreateTime": "2021-01-04T09:55:39Z",
        "BusinessType": "opening",
        "Title": "default_title_2021-01-04T09:55:39Z",
        "MediaType": "video",
        "InputURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4",
        "TranscodeStatus": "Init",
        "Source": "oss"
      }
    }
  ]
}