SearchMedia - 搜索媒体信息

更新时间:
复制 MD 格式

根据用户所提供参数,返回符合条件的媒资信息。

接口说明

阿里云智能媒体服务智能媒资搜索功能使用或问题咨询等,请搜索钉钉群(30415005038)加入智能媒体服务多模检索客户答疑群联系我们。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ice:SearchMedia

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Match

string

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

Title = 'China' and utcCreate = ['1693367158561','1693367158562']

SortBy

string

排序字段和排序顺序。多个使用英文逗号(,)分隔。

utcCreate:Desc

PageNo

integer

当前页码。默认值为 1。

1

PageSize

integer

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

20

EntityId

string

实体 ID。

2d3bf1e35a1e42b5ab338d701efa****

ScrollToken

string

翻页标识。32 字段。第一次执行搜索请求时不用设置本参数。搜索请求命中数据时,服务端会返回该参数值,用于记录当前搜索数据的位置地址。请记录返回的参数值,下一次搜索时按下述要求或建议设置本参数:需要遍历搜索条件命中的所有数据时,本参数必须设置。当 PageNo 参数取值超过 200 时,建议设置本参数优化搜索性能。只能向后翻页,最大翻页距离为 1000 媒资。

F8C4F642184DBDA5D93907A70AAE****

SearchLibName

string

搜索库。

test-1

CustomFilters

string

自定义过滤。JSON 字符串;支持字段 Int 型 intField1、字符串型 strField1、strField2;同一个字段最多可选择一种匹配,不同字段过滤时是且关系。

  • 精准,如 {"intField1":12,"strField1":"abc"}

  • 多值,如 {"intField1":[12,13],"strField1":["abc","cd"]}

  • 范围,如 {"intField1":{"gte":12,"lte":13}}

{"intField1":{"gte":12,"lte":13},"strField2":["cd","de"],"strField1":"abc"}

返回参数

名称

类型

描述

示例值

object

Schema of Response。

RequestId

string

请求 ID。

6F61C357-ACC0-57FB-876E-D5879533****

Success

string

是否成功。

True

Code

string

返回码。

200

MediaInfoList

array<object>

符合要求的媒资集合。

array<object>

媒资信息列表。

MediaId

string

媒资 ID。

3b187b3620c8490886cfc2a9578c****

MediaBasicInfo

object

媒资基础信息。

MediaId

string

媒资 ID。

132bd600fc3c71ec99476732a78f****

InputURL

string

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

oss://clipres/longvideo/material/voice/prod/20220418/07d7c799f6054dc3bbef250854cf8498165024814****

MediaType

string

媒资媒体类型。

video

BusinessType

string

媒资业务类型。

opening

Source

string

来源。

oss

Title

string

标题。

Smart landscape-to-portrait conversion

Description

string

内容描述。

对这个视频进行转码处理了

Category

string

分类。

image

MediaTags

string

标签。

tags,tags2

CoverURL

string

封面地址。

https://dtlive-bj.oss-cn-beijing.aliyuncs.com/cover/e694372e-4f5b-4821-ae09-efd064f2****_large_cover_url.jpg

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

媒资创建时间。

2020-12-01T19:48Z

ModifiedTime

string

媒资修改时间。

2020-12-01T19:48Z

DeletedTime

string

媒资删除时间。

2020-12-01T19:48Z

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

CateId

integer

分类 ID。

44

Biz

string

媒资所属业务。

IMS

UploadSource

string

上传资源。

general

CateName

string

分类名称。

Subcategory 1

ReferenceId

string

自定义 ID,仅支持小写字母、大写字母、数字、横线、下划线,长度 6-64 位。用户维度唯一。

123-123

Namespace

string

命名空间。

name-1

VisionDescription

string

视觉描述。

足球进球

StreamStatus

string

流状态

Active

FileInfoList

array<object>

FileInfos。

array<object>

fileinfo 列表。

FileBasicInfo

object

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

FileName

string

文件名。

164265080291300080527050.wav

FileStatus

string

文件状态。

Normal

FileType

string

文件类型。

source_file

FileSize

string

文件大小(字节)。

324784

FileUrl

string

文件 OSS 地址。

https://outin-d3f4681ddfd911ec99a600163e1403e7.oss-cn-shanghai.aliyuncs.com/sv/23d5cdd1-18180984899/23d5cdd1-1818098****.mp4

Region

string

文件存储区域。

cn-beijing

FormatName

string

封装格式。

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

Duration

string

时长。

60.00000

Bitrate

string

码率。

1912.13

Width

string

宽。

1920

Height

string

高。

480

CreateTime

string

创建时间。

2022-05-30T02:02:17Z

ModifiedTime

string

最后修改时间。

2021-12-10T12:19Z

ImagesInput

string

图片集信息。

{}

AiData

object

AI 详细信息

AiLabelInfo

array<object>

AI 标签信息列表

array<object>

AI 标签信息

FaceId

string

人脸 ID

5FE19530C7A422197535FE74F5DB****

LabelType

string

标签类型

Object

Source

string

来源

vision

Category

string

分类

Vehicle

LabelName

string

实体名称

Car

LabelId

string

实体 ID

10310250338

Occurrences

array<object>

片段列表

array<object>

片段

Score

number

打分

0.75287705

Image

string

最优人脸图片的 base64 编码

99C64F6287

TableBatchSeqId

string

向量表序列 ID

85010D1

clipId

string

片段 ID

5FE19530C7A422197535FE74F5DB****

From

number

片段起始时间

1.4

To

number

片段结束时间

2.5

FinegrainName

string

实体的细粒度名称

Car

FinegrainId

string

实体的细粒度 ID

10310250338

Content

string

文本内容

Pipi

Tracks

array<object>

track 序列

object

序列

Size

number

人脸 bbox 框的面积

50.2

Position

string

bbox 框位置坐标

468.0;67.0;615.0;267.0

Timestamp

number

track 的时间戳

1.4

AsrInfo

array<object>

语音信息列表

object

语音信息

From

number

片段起始时间

1.4

To

number

片段结束时间

2.5

ClipId

string

片段 ID

5FE19530C7A422197535FE74F5DB****

Content

string

文本内容

I am Pipi.

Timestamp

number

片段时间戳

1.4

OcrInfo

array<object>

字幕信息列表

object

字幕信息

From

number

片段起始时间

1.4

To

number

片段结束时间

2.5

ClipId

string

片段 ID

5FE19530C7A422197535FE74F5DB****

Content

string

文本内容

我是皮皮

Timestamp

number

片段时间戳

1.4

AiRoughData

object

AI 简介数据

SaveType

string

保存类型

TEXT

Status

string

数据状态

SaveSuccess

AiJobId

string

AI 任务 ID

cd35b0b0025f71edbfcb472190a9****

Result

string

AI 结果

http://xxxx.json

AiCategory

string

电视剧

视频AI分类

IndexStatusList

array<object>

索引状态列表。

object

索引状态。

IndexType

string

索引类别。取值:

  • mm:大模型。

  • face:人脸。

  • aiLabel:智能标签。

mm

IndexStatus

string

索引状态。取值:

  • Running:运行中。

  • Fail:失败。

  • Success: 成功。

Success

CustomFields

string

自定义过滤参数。

{\"intField1\":12,\"strField1\":\"abc\"}

ScrollToken

string

翻页标识。

F8C4F642184DBDA5D93907A70AAE****

Total

integer

符合条件的媒资总数。

163

示例

正常返回示例

JSON格式

{
  "RequestId": "6F61C357-ACC0-57FB-876E-D5879533****",
  "Success": "True",
  "Code": "200",
  "MediaInfoList": [
    {
      "MediaId": "3b187b3620c8490886cfc2a9578c****",
      "MediaBasicInfo": {
        "MediaId": "132bd600fc3c71ec99476732a78f****",
        "InputURL": "oss://clipres/longvideo/material/voice/prod/20220418/07d7c799f6054dc3bbef250854cf8498165024814****",
        "MediaType": "video",
        "BusinessType": "opening",
        "Source": "oss",
        "Title": "Smart landscape-to-portrait conversion",
        "Description": "对这个视频进行转码处理了",
        "Category": "image",
        "MediaTags": "tags,tags2\n",
        "CoverURL": "https://dtlive-bj.oss-cn-beijing.aliyuncs.com/cover/e694372e-4f5b-4821-ae09-efd064f2****_large_cover_url.jpg",
        "UserData": "userData",
        "Snapshots": "[{\"bucket\":\"example-bucket\",\"count\":\"3\",\"iceJobId\":\"******f48f0e4154976b2b8c45******\",\"location\":\"oss-cn-beijing\",\"snapshotRegular\":\"example.jpg\",\"templateId\":\"******e6a6440b29eb60bd7c******\"}]",
        "Status": "Normal",
        "TranscodeStatus": "Init",
        "CreateTime": "2020-12-01T19:48Z",
        "ModifiedTime": "2020-12-01T19:48Z\n",
        "DeletedTime": "2020-12-01T19:48Z\n",
        "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": 44,
        "Biz": "IMS",
        "UploadSource": "general",
        "CateName": "Subcategory 1",
        "ReferenceId": "123-123",
        "Namespace": "name-1",
        "VisionDescription": "足球进球",
        "StreamStatus": "Active"
      },
      "FileInfoList": [
        {
          "FileBasicInfo": {
            "FileName": "164265080291300080527050.wav",
            "FileStatus": "Normal",
            "FileType": "source_file",
            "FileSize": "324784",
            "FileUrl": "https://outin-d3f4681ddfd911ec99a600163e1403e7.oss-cn-shanghai.aliyuncs.com/sv/23d5cdd1-18180984899/23d5cdd1-1818098****.mp4",
            "Region": "cn-beijing",
            "FormatName": "mov,mp4,m4a,3gp,3g2,mj2",
            "Duration": "60.00000\n",
            "Bitrate": "1912.13\n",
            "Width": "1920",
            "Height": "480",
            "CreateTime": "2022-05-30T02:02:17Z",
            "ModifiedTime": "2021-12-10T12:19Z",
            "ImagesInput": "{}"
          }
        }
      ],
      "AiData": {
        "AiLabelInfo": [
          {
            "FaceId": "5FE19530C7A422197535FE74F5DB****",
            "LabelType": "Object",
            "Source": "vision",
            "Category": "Vehicle",
            "LabelName": "Car",
            "LabelId": "10310250338",
            "Occurrences": [
              {
                "Score": 0.75287705,
                "Image": "99C64F6287",
                "TableBatchSeqId": "85010D1",
                "clipId": "5FE19530C7A422197535FE74F5DB****",
                "From": 1.4,
                "To": 2.5,
                "FinegrainName": "Car",
                "FinegrainId": "10310250338",
                "Content": "Pipi",
                "Tracks": [
                  {
                    "Size": 50.2,
                    "Position": "468.0;67.0;615.0;267.0",
                    "Timestamp": 1.4
                  }
                ]
              }
            ]
          }
        ],
        "AsrInfo": [
          {
            "From": 1.4,
            "To": 2.5,
            "ClipId": "5FE19530C7A422197535FE74F5DB****",
            "Content": "I am Pipi.",
            "Timestamp": 1.4
          }
        ],
        "OcrInfo": [
          {
            "From": 1.4,
            "To": 2.5,
            "ClipId": "5FE19530C7A422197535FE74F5DB****",
            "Content": "我是皮皮",
            "Timestamp": 1.4
          }
        ]
      },
      "AiRoughData": {
        "SaveType": "TEXT",
        "Status": "SaveSuccess",
        "AiJobId": "cd35b0b0025f71edbfcb472190a9****",
        "Result": "http://xxxx.json",
        "AiCategory": "视频AI分类"
      },
      "IndexStatusList": [
        {
          "IndexType": "mm",
          "IndexStatus": "Success"
        }
      ],
      "CustomFields": "{\\\"intField1\\\":12,\\\"strField1\\\":\\\"abc\\\"}"
    }
  ],
  "ScrollToken": "F8C4F642184DBDA5D93907A70AAE****",
  "Total": 163
}

错误码

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

变更历史

更多信息,参考变更详情