You need to enable JavaScript to run this app.
视频点播

视频点播

请输入
  • 文档首页
    • 视频点播服务端 API 参考媒资管理GetMediaEntityList - 获取媒资实体列表
复制全文
我的收藏
媒资管理
GetMediaEntityList - 获取媒资实体列表
复制全文
我的收藏
GetMediaEntityList - 获取媒资实体列表

调用 GetMediaEntityList 接口根据查询条件（如视频 ID、实体类型等）分页获取指定视频关联的 AI 媒资实体（如智能切片、人声/背景音、OCR 结果等）列表。

使用说明

通过此接口，您可以获取一个

请求说明

请求地址：https://vod.volcengineapi.com?Action=GetMediaEntityList&Version=2023-07-01

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

参数
类型
是否必选
示例值
描述
Action
String
是
GetMediaEntityList
接口名称。当前 API 的名称为 GetMediaEntityList。
Version
String
是
2023-07-01
接口版本。当前 API 的版本为 2023-07-01。
Vid
String
是
v0dc24g10***s1v0ipljnh4h0

视频 ID。音视频上传后，获取的方式如下所示。

EntityTypes
String
否
ocr,segment

实体类型。指定要查询的实体具体类型，支持的取值如下：

  • ocr：OCR 提取字幕结果。
  • segment：智能场景切分的结构化数据。
  • human_voice：人声背景音分离后提取的纯人声音频。
  • background_voice：人声背景音分离后提取的背景伴奏音频。
EntityVersions
String
否
default
实体标识。当前仅支持 default。
Sources
String
否
-

来源标签列表。其具体取值将由产生该实体的 AI 应用（例如 OCR 提取字幕、人声背景音分离等）在向智能媒资系统写入数据时自行定义并上报。通过此字段，您可以实现按任务来源查询实体。

说明

目前相关 AI 应用尚未定义具体的取值，该参数暂无生效的筛选值，无需传值。

PageNumber
Integer
否
1
分页查询的页码。默认值为 1。
PageSize
Integer
否
10
分页查询时每页返回的条目数。默认值为 10，最大值为 100。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数
类型
示例值
描述
PageSize
Integer
10
当前每页条目数。
PageNumber
Integer
1
当前页码。
TotalCount
Integer
25
符合查询条件的结果总数。
BaseEntityInfos
Object[]
-
基础实体信息列表
Id
String
entity-12345
实体的唯一标识 ID。
Vid
String
v0c2dfg7007***eq0bnog65linio2jvg
所属视频 ID。
Source
String
translation
实体的来源。
FileName
String
subtitle.srt
实体的文件路径。
StoreUri
String
tos-boe-v-febf3a/subtitle.srt
实体在对象存储中的 URI。
CreatedAt
String
2025-11-21T02:00:00Z
创建时间，UTC 格式。
SpaceName
String
vod-test
所属空间名称。
UpdatedAt
String
2025-11-21T02:00:00Z
更新时间，UTC 格式。
EntityType
String
ocr
实体类型。
EntityVersion
String
default
实体标识。
EntityBaseRawInfo
String
{"vid":"v0c2dfg***7ad5eq0bnog65linio2jvg","entity_type":"ocr","entity_version":"default","space_name":"vod-test","store_uri":"tos-boe-v-febf3a/subtitle.srt","file_name":"subtitle.srt","source":"translation","created_at":1767928529,"updated_at":1767928529}
基础语义数据的 JSON 字符串。该字段是对实体核心属性（如 vid, file_name, store_uri 等）的序列化封装。您将其反序列化后，可得到一个与外层 BaseEntityInfo 结构基本一致的对象，可用于直接投喂给大模型或下游分析系统。

请求示例 

https://vod.volcengineapi.com?Action=GetMediaEntityList&Version=2023-07-01
{
  "Vid": "v0dc24g10***s1v0ipljnh4h0",
  "EntityTypes": "ocr,segment",
  "EntityVersions": "default",
  "PageNumber": 1,
  "PageSize": 10
}

返回示例 

{
  "Result": {
    "PageSize": 10,
    "PageNumber": 1,
    "TotalCount": 25,
    "BaseEntityInfos": [
      {
        "Id": "entity-12345",
        "Vid": "v0c2dfg7007***eq0bnog65linio2jvg",
        "Source": "translation",
        "FileName": "subtitle.srt",
        "StoreUri": "tos-boe-v-febf3a/subtitle.srt",
        "CreatedAt": "2025-11-21T02:00:00Z",
        "SpaceName": "vod-test",
        "UpdatedAt": "2025-11-21T02:00:00Z",
        "EntityType": "ocr",
        "EntityVersion": "default",
        "EntityBaseRawInfo": "{\"vid\":\"v0c2dfg***7ad5eq0bnog65linio2jvg\",\"entity_type\":\"ocr\",\"entity_version\":\"default\",\"space_name\":\"vod-test\",\"store_uri\":\"tos-boe-v-febf3a/subtitle.srt\",\"file_name\":\"subtitle.srt\",\"source\":\"translation\",\"created_at\":1767928529,\"updated_at\":1767928529}"
      }
    ]
  },
  "ResponseMetadata": {
    "Action": "GetMediaEntityList",
    "Region": "cn-north-1",
    "Service": "vod",
    "Version": "2023-07-01",
    "RequestId": "20230604110420****100232280022D31"
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。

最近更新时间：2026.03.17 14:50:01
这个页面对您有帮助吗？
有用
有用
无用
无用