根据用户所给参数,返回所有符合条件的媒资的基础信息。
接口说明
-
如果 includeFileBasicInfo 字段为真,还会返回源文件基础信息,例如:时长、文件大小。
-
最多筛选符合条件的前 100 条。
-
所有符合条件的媒资需要精确匹配所有非空字段。支持精确匹配的字段有媒资媒体类型、来源、媒资业务类型、分类、资源状态。
-
当一次性无法返回所有信息时,用户可使用 nextToken 进行下一轮查询。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ice:ListMediaBasicInfos | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
StartTime | string | 否 | utcCreated(创建时间)的开始时间。
| 2020-12-20T12:00:00Z |
EndTime | string | 否 | utcCreated 的结束时间。
| 2020-12-20T13:00:00Z |
MediaType | string | 否 | 媒资媒体类型。取值范围:
| video |
BusinessType | string | 否 | 媒资业务类型。取值范围:
| opening |
Source | string | 否 | 来源。
| oss |
Status | string | 否 | 资源状态。取值范围:
| Normal |
NextToken | string | 否 | 用来表示当前调用返回读取到的位置,空代表数据已经读取完毕。 | pSa1SQ0wCe5pzVrQ6mWZEw== |
MaxResults | integer | 否 | 本次请求所返回的最大记录条数。 最大值:100,默认值:10 | 5 |
SortBy | string | 否 | 根据 utcCreated 排序, 默认倒序
| desc |
IncludeFileBasicInfo | boolean | 否 | 如果为 true,返回值中包含文件基础信息。 | true |
MediaId | string | 否 | 媒资 ID | ****019b82e24b37a1c2958dec38**** |
返回参数
示例
正常返回示例
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\"}]",
"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
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2021-03-31 | OpenAPI 返回结构发生变更 | 查看变更详情 |