文档

ListPublicMediaBasicInfos - 列出公共素材库媒资基础信息

更新时间:

列出符合条件的公共素材库媒资基础信息,最多筛选出100条。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
MediaTagIdstring

媒资标签,根据此 mediaTagId 进行匹配,返回所有包含此标签的媒资。取值:

  • sticker(贴纸类型)
    • sticker-atmosphere:气氛
    • sticker-bubble:气泡
    • sticker-cute:可爱
    • sticker-daily:日常
    • sticker-expression:表情
    • sticker-gif:动图
  • bgm(背景音乐类型)
    • bgm-romantic:浪漫
    • bgm-cuisine:美食
    • bgm-chinese-style:国风
    • bgm-upbeat:轻快
    • bgm-dynamic:动感
    • bgm-relaxing:舒缓
    • bgm-quirky:搞怪
    • bgm-beauty:时尚/美妆
  • bgi(背景图片类型)
    • bgi-grad:渐变背景
    • bgi-solid:纯色背景
    • bgi-pic:图片背景
sticker-atmosphere
NextTokenstring

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

pSa1SQ0wCe5pzVrQ6mWZEw==
MaxResultsinteger

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

最大值:100,默认值:10

5
PageNointeger

当前页码。默认值为 1

1
PageSizeinteger

分页大小,每页显示条数。默认值为 10,最大值为 100。

10
IncludeFileBasicInfoboolean

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

true
BusinessTypestring

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

  • sticker:贴纸

  • bgm:背景音乐

  • bgi:背景图片

sticker

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

******B7-7F87-4792-BFE9-63CD21******
TotalCountlong

符合要求的媒资总数。

2
MediaInfosobject []

符合要求的媒资集合。

MediaIdstring

媒资 ID。

****019b82e24b37a1c2958dec38****
MediaBasicInfoobject

媒资基础信息。

MediaIdstring

媒资 ID。

****019b82e24b37a1c2958dec38****
InputURLstring

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

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

媒资媒体类型。

video
BusinessTypestring

媒资业务类型。

general
Sourcestring

来源。

oss
Titlestring

标题。

title标题
Descriptionstring

内容描述。

description
Categorystring

分类。

video
MediaTagsstring

标签。

sticker-daily
CoverURLstring

封面地址。

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

用户数据。

userData
Snapshotsstring

截图。

null
Statusstring

资源状态。

Normal
TranscodeStatusstring

转码状态。

Init
CreateTimestring

媒资创建时间。

2021-01-08T16:52:04Z
ModifiedTimestring

媒资修改时间。

2021-01-08T16:52:04Z
DeletedTimestring

媒资删除时间。

2021-01-08T16:52:04Z
FileInfoListobject []

文件信息。

FileBasicInfoobject

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

FileNamestring

文件名。

example.mp4
FileStatusstring

文件状态。

Normal
FileTypestring

文件类型。

source_file
FileSizestring

文件大小(字节)。

338990717
FileUrlstring

文件 OSS 地址。

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

文件存储区域。

cn-shanghai
FormatNamestring

封装格式。

mov,mp4,m4a,3gp,3g2,mj2
Durationstring

时长。

10.040000
Bitratestring

码率。

270112.12
Widthstring

宽。

1920
Heightstring

高。

1080
NextTokenstring

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

8EqYpQbZ6Eh7+Zz8DxVYoQ==
MaxResultsinteger

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

2

示例

正常返回示例

JSON格式

{
  "RequestId": "******B7-7F87-4792-BFE9-63CD21******",
  "TotalCount": 2,
  "MediaInfos": [
    {
      "MediaId": "****019b82e24b37a1c2958dec38****",
      "MediaBasicInfo": {
        "MediaId": "****019b82e24b37a1c2958dec38****",
        "InputURL": "https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4",
        "MediaType": "video",
        "BusinessType": "general",
        "Source": "oss",
        "Title": "title标题",
        "Description": "description",
        "Category": "video",
        "MediaTags": "sticker-daily",
        "CoverURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>",
        "UserData": "userData",
        "Snapshots": "null",
        "Status": "Normal",
        "TranscodeStatus": "Init",
        "CreateTime": "2021-01-08T16:52:04Z",
        "ModifiedTime": "2021-01-08T16:52:04Z",
        "DeletedTime": "2021-01-08T16:52:04Z"
      },
      "FileInfoList": [
        {
          "FileBasicInfo": {
            "FileName": "example.mp4",
            "FileStatus": "Normal",
            "FileType": "source_file",
            "FileSize": "338990717",
            "FileUrl": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>",
            "Region": "cn-shanghai",
            "FormatName": "mov,mp4,m4a,3gp,3g2,mj2",
            "Duration": "10.040000",
            "Bitrate": "270112.12",
            "Width": "1920",
            "Height": "1080"
          }
        }
      ]
    }
  ],
  "NextToken": "8EqYpQbZ6Eh7+Zz8DxVYoQ==",
  "MaxResults": 2
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-01-26OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:BusinessType
  • 本页导读 (1)