首页 视频点播 API参考指南 API目录 媒资管理 媒资搜索 SearchMedia - 搜索媒体信息

SearchMedia - 搜索媒体信息

搜索媒资信息，包括视频、音频、图片、辅助媒资等。

接口说明

获取命中数据条数限制说明如下：

  • 方法一：遍历搜索条件命中的前5000条数据，需要使用PageNo和PageSize参数翻页遍历。当搜索条件命中的数据条数超过5000条时，使用该方式无法遍历所有数据，需使用方式二。
  • 方法二：仅视频、音频搜索支持，遍历搜索条件命中的所有数据，需要使用PageNo、PageSize和ScrollToken参数翻页遍历，且目标翻页位置与当前翻页位置之间不能超过1200条数据。以PageSize取值20为例：
    • 当PageNo取值为1时，目标翻页位置向后最多可查询60页。
    • 当PageNo取值为2时，目标翻页位置向后最多可查询61页。
    • 当PageNo取值为61时，目标翻页位置向前最多可查询2页，目标翻页位置向后最多可查询120页。

QPS限制

本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
vod:SearchMediaList
  • VOD
    acs:vod:*:{#accountId}:*/*
    无
无

请求参数

名称类型必填描述示例值
SearchTypestring否

搜索媒资数据类型。取值范围：

  • video（默认值）：视频。
  • audio：音频。
  • image：图片。
  • attached：辅助媒资。
说明当本参数取值为video或audio，且需要遍历搜索条件命中的所有数据时，必须设置ScrollToken参数。
video
Fieldsstring否

搜索结果中返回的媒资字段。

默认只返回基本媒资字段，可指定返回更多媒资字段，请参见使用示例。

Title,CoverURL
Matchstring否

过滤条件。语法规则，请参见搜索协议语法。

field = value
SortBystring否

排序字段和排序顺序。多个使用半角逗号（,）分隔。取值：

  • CreationTime:Desc（默认值）：按创建时间倒序。
  • CreationTime:Asc：按创建时间升序。
说明
  • 排序字段示例：排序字段。
  • 获取搜索条件是前5000条的数据时，最多支持三个排序字段。
  • 获取搜索条件是所有数据时，仅支持一个排序字段。
    		• CreationTime:Desc
    PageNointeger否

    当前页码。默认值为1。

    说明当本参数取值超过200时，建议同时设置ScrollToken参数。
    		1
    PageSizeinteger否

    每页返回的数据条数。默认值为10，最大值为100。

    		10
    ScrollTokenstring否

    翻页标识。32字段。 第一次执行搜索请求时不用设置本参数。搜索请求命中数据时，服务端会返回该参数值，用于记录当前搜索数据的位置地址。请记录返回的参数值，下一次搜索时按下述要求或建议设置本参数：

    • 当SearchType参数取值为video或audio，且需要遍历搜索条件命中的所有数据时，本参数必须设置。
    • 当PageNo参数取值超过200时，建议设置本参数优化搜索性能。
    		24e0fba7188fae707e146esa54****

    返回参数

    名称类型描述示例值
    object

    返回结果。

    RequestIdstring

    请求ID。

    		3E0CEF83-FB09-4E34-BA1451814B03****
    Totallong

    满足搜索条件的媒资信息总条数。

    		10
    ScrollTokenstring

    翻页标识。

    		24e0fba7188fae707e146esa54****
    MediaListobject []

    媒资信息列表。

    CreationTimestring

    媒体创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

    		2018-07-19T03:45:25Z
    MediaTypestring

    媒体类型。取值范围：

    • video：视频。
    • audio：音频。
    • image：图片。
    • attached：辅助媒资。
    		video
    MediaIdstring

    媒体ID。

    		a82a2cd7d4e147bbed6c1ee372****
    Videoobject

    视频信息。

    Statusstring

    状态。取值：

    • Uploading：上传中。
    • UploadFail：上传失败。
    • UploadSucc：上传完成。
    • Transcoding：转码中。
    • TranscodeFail：转码失败。
    • Blocked：屏蔽。
    • Normal：正常。
    		UploadSucc
    CreationTimestring

    视频信息创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

    		2018-07-19T03:45:25Z
    StorageLocationstring

    存储区域。

    		outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com
    CateIdlong

    分类ID。

    		10000123
    Tagsstring

    视频标签。

    		tag1
    ModificationTimestring

    视频信息更新时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

    		2018-07-19T03:48:25Z
    MediaSourcestring

    来源。取值：

    • general：点播上传。
    • short_video：短视频SDK。
    • editing：剪辑合成。
    • live：直播录制。
    		general
    Descriptionstring

    视频描述。

    		视频测试
    AppIdstring

    应用ID。

    		app-****
    CoverURLstring

    封面图片。

    		https://example.aliyundoc.com/image01.png
    VideoIdstring

    视频ID。

    		a82a2asdasqadaf3faa0ed6c1ee372****
    DownloadSwitchstring

    下载开关。只有状态开启时才允许离线下载。取值范围：

    • on（开启）：初始状态，允许离线下载。
    • off（禁用）：禁用离线下载。
    		on
    CateNamestring

    分类名称。

    		video1
    TranscodeModestring

    转码模式。取值：

    • FastTranscode（普通转码）：默认模式，上传完成即开始转码，且转码完成才能播放。
    • NoTranscode（不转码即分发）：上传完成不转码，且立即能播放。
    • AsyncTranscode（上传即分发并转码） ：上传完成即能播放，同时异步进行转码。
    		FastTranscode
    PreprocessStatusstring

    预处理状态 。取值：

    • UnPreprocess：未进行预处理。
    • Preprocessing：预处理中。
    • PreprocessSucceed：预处理完成。
    • PreprocessFailed：预处理失败。
    		Preprocessing
    RestoreExpirationstring

    媒资解冻有效期。

    		2023-03-30T10:14:14Z
    RestoreStatusstring

    媒资解冻状态。取值：

    • Processing：解冻中。
    • Success：解冻成功。
    • Failed：解冻失败。
    		Success
    StorageClassstring

    媒资存储类型。取值：

    • Standard：标准。
    • IA：媒资低频。
    • Archive：媒资归档。
    • ColdArchive：媒资冷归档。
    • SourceIA：源文件低频。
    • SourceArchive：源文件归档。
    • SourceColdArchive：源文件冷归档。
    • Changing：变更中。
    		Standard
    Sizelong

    视频大小。

    		123
    Durationfloat

    视频时长。单位：秒。

    		123
    Titlestring

    视频标题。

    		ceshi
    SpriteSnapshotsarray

    雪碧图列表。

    string

    雪碧图列表。

    		{“http://example.aliyundoc.com/image02.jpg”}
    Snapshotsarray

    自动截图列表。

    string

    自动截图列表。

    		{“http://example.aliyundoc.com/image03.jpg”}
    Audioobject

    音频信息。

    Statusstring

    状态。取值：

    • Uploading：上传中。
    • Normal：正常。
    • UploadFail：失败。
    • Deleted：删除。
    		Normal
    CreationTimestring

    创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

    		2018-07-19T03:45:25Z
    StorageLocationstring

    存储区域。

    		outin-aaa*****aa.oss-cn-shanghai.aliyuncs.com
    CateIdlong

    分类ID。

    		10000123
    Tagsstring

    标签。

    		tag1,tag2
    ModificationTimestring

    更新时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

    		2018-07-19T03:48:25Z
    MediaSourcestring

    来源。取值：

    • general（点播上传）：普通上传。
    • short_video（短视频SDK）： 通过短视频SDK上传文件至点播，详细内容请参见短视频SDK。
    • editing（剪辑合成）：通过云剪辑合成上传文件至点播，详细内容请参见视频合成。
    • live（直播录制）：通过直播录制上传文件至点播。
    		general
    Descriptionstring

    描述。

    		音频描述
    AppIdstring

    应用ID。

    		app-****
    CoverURLstring

    封面图片。

    		http://example.com/image04.jpg
    AudioIdstring

    音频ID。

    		a82a2cd7d4e147bbed6c1ee372****
    DownloadSwitchstring

    下载开关。只有状态开启时才允许离线下载。取值：

    • on（开启）：初始状态，允许离线下载。
    • off（禁用）：禁用离线下载。
    		on
    CateNamestring

    分类名称。

    		ceshi
    TranscodeModestring

    转码模式。取值范围：

    • FastTranscode（普通转码，默认值）：上传完成即开始转码，且转码完成才能播放。
    • NoTranscode（不转码即分发）：上传完成不转码，且立即能播放。
    • AsyncTranscode（上传即分发并转码）：上传完成即能播放，同时异步进行转码。
    		FastTranscode
    PreprocessStatusstring

    预处理状态，预处理完成后的视频才可用于直播导播。取值：

    • UnPreprocess：未进行预处理。
    • Preprocessing：预处理中。
    • PreprocessSucceed：预处理完成。
    • PreprocessFailed：预处理失败。
    		UnPreprocess
    RestoreExpirationstring

    媒资解冻有效期。

    		2023-03-30T10:14:14Z
    RestoreStatusstring

    媒资解冻状态。取值：

    • Processing：解冻中。
    • Success：解冻成功。
    • Failed：解冻失败。
    		Success
    StorageClassstring

    媒资存储类型。取值：

    • Standard：标准。
    • IA：媒资低频。
    • Archive：媒资归档。
    • ColdArchive：媒资冷归档。
    • SourceIA：源文件低频。
    • SourceArchive：源文件归档。
    • SourceColdArchive：源文件冷归档。
    • Changing：变更中。
    		Standard
    Sizelong

    大小。

    		123
    Durationfloat

    时长。

    		123
    Titlestring

    标题。

    		音频
    SpriteSnapshotsarray

    雪碧图列表。

    string

    雪碧图列表。

    		{“http://example.aliyundoc.com/image02.jpg”}
    Snapshotsarray

    自动截图列表。

    string

    自动截图列表。

    		{“http://example.aliyundoc.com/image03.jpg”}
    Imageobject

    图片信息。

    StorageLocationstring

    存储地域。

    		outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com
    CreationTimestring

    创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

    		2018-07-19T03:45:25Z
    Statusstring

    图片状态。

    • Uploading（上传中）：初始状态，表示图片正在上传。
    • Normal（正常）：图片上传成功。
    • UploadFail（失败）：图片上传失败。
    		Uploading
    CateIdlong

    分类ID。

    		1000123
    Tagsstring

    标签。

    		tag1
    ModificationTimestring

    更新时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

    		2018-07-19T03:48:25Z
    CateNamestring

    分类名称。

    		美图1
    Descriptionstring

    描述。

    		图片测试
    AppIdstring

    应用ID。

    		app-****
    URLstring

    图片URL。

    		https://example.com/****.png
    Titlestring

    标题。

    		image1
    ImageIdstring

    图片ID。

    		11130843741se99wqmoes****
    AttachedMediaobject

    辅助媒资信息。

    CreationTimestring

    创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

    		2018-07-19T03:45:25Z
    Statusstring

    状态。取值：

    • Uploading（上传中）： 初始状态，表示辅助媒资正在上传。
    • Normal（正常）：辅助媒资上传成功。
    • UploadFail（失败）：辅助媒资上传失败。
    		Normal
    StorageLocationstring

    存储区域。

    		outin-bfefbb90a47c11*****7426.oss-cn-shanghai.aliyuncs.com
    Tagsstring

    标签。

    		测试
    ModificationTimestring

    更新时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

    		2018-07-19T03:48:25Z
    MediaIdstring

    辅助媒资ID。

    		a82a2cd7d4e147ba0ed6c1ee372****
    BusinessTypestring

    业务类型。取值：

    • watermark：水印。
    • subtitle：字幕。
    • material：素材。
    		watermark
    Descriptionstring

    描述。

    		测试
    AppIdstring

    应用ID。

    		app-****
    URLstring

    辅助媒资URL。

    		https://example.com/****.png
    Titlestring

    标题。

    		测试
    Categoriesobject []

    分类ID列表。

    ParentIdlong

    父节点ID。

    		-1
    CateNamestring

    分类名称。

    		测试
    CateIdlong

    分类ID。

    		10027394
    Levellong

    分类层级。

    		1
    AiDataobject

    AI详细信息。

    AiLabelInfoobject []

    AI标签信息列表。

    Categorystring

    分类。

    		交通工具
    LabelNamestring

    实体名称。

    		车
    LabelIdstring

    实体ID。

    		10310250338
    Occurrencesobject []

    片段列表。

    Scoredouble

    打分。

    		0.75287705
    Fromdouble

    片段起始时间。

    		1.4
    Todouble

    片段结束时间。

    		2.5
    OcrInfoobject []

    字幕信息列表。

    Fromdouble

    片段起始时间。

    		1.4
    Todouble

    片段结束时间。

    		2.5
    Contentstring

    文本内容。

    		我是皮皮
    AiRoughDataobject

    AI简介数据。

    SaveTypestring

    保存类型。

    		TEXT
    Statusstring

    数据状态。

    		SaveSuccess
    AiJobIdstring

    AI任务ID。

    		cd35b0b0025f71edbfcb472190a9xxxx
    AiCategorystring

    视频AI分类。

    		电视剧

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "3E0CEF83-FB09-4E34-BA1451814B03****",
  "Total": 10,
  "ScrollToken": "24e0fba7188fae707e146esa54****",
  "MediaList": [
    {
      "CreationTime": "2018-07-19T03:45:25Z",
      "MediaType": "video",
      "MediaId": "a82a2cd7d4e147bbed6c1ee372****",
      "Video": {
        "Status": "UploadSucc",
        "CreationTime": "2018-07-19T03:45:25Z",
        "StorageLocation": "outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com",
        "CateId": 10000123,
        "Tags": "tag1",
        "ModificationTime": "2018-07-19T03:48:25Z",
        "MediaSource": "general",
        "Description": "视频测试",
        "AppId": "app-****",
        "CoverURL": "https://example.aliyundoc.com/image01.png",
        "VideoId": "a82a2asdasqadaf3faa0ed6c1ee372****",
        "DownloadSwitch": "on",
        "CateName": "video1",
        "TranscodeMode": "FastTranscode",
        "PreprocessStatus": "Preprocessing",
        "RestoreExpiration": "2023-03-30T10:14:14Z",
        "RestoreStatus": "Success",
        "StorageClass": "Standard",
        "Size": 123,
        "Duration": 123,
        "Title": "ceshi",
        "SpriteSnapshots": [
          "{“http://example.aliyundoc.com/image02.jpg”}"
        ],
        "Snapshots": [
          "{“http://example.aliyundoc.com/image03.jpg”}"
        ]
      },
      "Audio": {
        "Status": "Normal",
        "CreationTime": "2018-07-19T03:45:25Z",
        "StorageLocation": "outin-aaa*****aa.oss-cn-shanghai.aliyuncs.com",
        "CateId": 10000123,
        "Tags": "tag1,tag2",
        "ModificationTime": "2018-07-19T03:48:25Z",
        "MediaSource": "general",
        "Description": "音频描述",
        "AppId": "app-****",
        "CoverURL": "http://example.com/image04.jpg",
        "AudioId": "a82a2cd7d4e147bbed6c1ee372****",
        "DownloadSwitch": "on",
        "CateName": "ceshi",
        "TranscodeMode": "FastTranscode",
        "PreprocessStatus": "UnPreprocess",
        "RestoreExpiration": "2023-03-30T10:14:14Z",
        "RestoreStatus": "Success",
        "StorageClass": "Standard",
        "Size": 123,
        "Duration": 123,
        "Title": "音频",
        "SpriteSnapshots": [
          "{“http://example.aliyundoc.com/image02.jpg”}"
        ],
        "Snapshots": [
          "{“http://example.aliyundoc.com/image03.jpg”}"
        ]
      },
      "Image": {
        "StorageLocation": "outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com",
        "CreationTime": "2018-07-19T03:45:25Z",
        "Status": "Uploading",
        "CateId": 1000123,
        "Tags": "tag1",
        "ModificationTime": "2018-07-19T03:48:25Z",
        "CateName": "美图1",
        "Description": "图片测试",
        "AppId": "app-****",
        "URL": "https://example.com/****.png",
        "Title": "image1",
        "ImageId": "11130843741se99wqmoes****"
      },
      "AttachedMedia": {
        "CreationTime": "2018-07-19T03:45:25Z",
        "Status": "Normal",
        "StorageLocation": "outin-bfefbb90a47c11*****7426.oss-cn-shanghai.aliyuncs.com",
        "Tags": "测试",
        "ModificationTime": "2018-07-19T03:48:25Z",
        "MediaId": "a82a2cd7d4e147ba0ed6c1ee372****",
        "BusinessType": "watermark",
        "Description": "测试",
        "AppId": "app-****",
        "URL": "https://example.com/****.png",
        "Title": "测试",
        "Categories": [
          {
            "ParentId": -1,
            "CateName": "测试",
            "CateId": 10027394,
            "Level": 1
          }
        ]
      },
      "AiData": {
        "AiLabelInfo": [
          {
            "Category": "交通工具",
            "LabelName": "车",
            "LabelId": "10310250338",
            "Occurrences": [
              {
                "Score": 0.75287705,
                "From": 1.4,
                "To": 2.5
              }
            ]
          }
        ],
        "OcrInfo": [
          {
            "From": 1.4,
            "To": 2.5,
            "Content": "我是皮皮\n"
          }
        ]
      },
      "AiRoughData": {
        "SaveType": "TEXT\n",
        "Status": "SaveSuccess",
        "AiJobId": "cd35b0b0025f71edbfcb472190a9xxxx",
        "AiCategory": "电视剧\n"
      }
    }
  ]
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2023-04-11OpenAPI 返回结构发生变更
    变更项变更内容
    出参OpenAPI 返回结构发生变更

    接口错误码

    下表列举了本接口特有的错误码。

    错误代码错误信息HTTP 状态码说明
    SortByExceededMaxThe SortBy parameter only supports one sort field when traversing all data.400遍历所有数据时，仅支持一个排序字段。
    ErrorMatchSyntaxThe parameter Match.%s has an error syntax, please check it.400Match参数语法错误，请检查后重试。
    InvalidScrollToken.ExpiredThe ScrollToken is expired，please refresh it.400翻页标识过期，请从第一页重新获取数据。
    阿里云首页 视频点播 相关技术圈