You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /视频点播/API 参考/媒资管理/更新媒资信息
更新媒资信息
最近更新时间：2024.09.19 17:51:58首次发布时间：2021.02.23 10:42:38
我的收藏

此接口用于通过 Vid（视频 ID）更新媒资信息，包括标题、描述、标签、分类、封面图、过期时间等。

请求说明

请求地址：https://vod.volcengineapi.com?Action=UpdateMediaInfo&Version=2020-08-01

调试

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

请求参数

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

参数
类型
是否必选
示例值
描述
Action
String
是
UpdateMediaInfo
接口名称。当前 API 的名称为 UpdateMediaInfo。
Version
String
是
2020-08-01
接口版本。当前 API 的版本为 2020-08-01。
Vid
String
是
v03c24g100***ps1v0vcd6b5r1g

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

PosterUri
String
否
tos-vod-cn-v-03***112705/hello vod_cover
视频封面图片 URI。您可先获取某图片的 URI，再通过此参数将该图片设置为视频封面。更多信息，请见设置视频封面。
Title
String
否
视频
视频名称。长度最大为 512 个字符。
Description
String
否
视频测试
视频描述。长度最大为 1024 个字符。
Tags
String
否
01

视频标签。以英文逗号 , 分隔多条。

  • 传空：删除所有标签。
  • 不传：不修改。
ClassificationId
Long
否
001

视频分类 ID。

  • 不传：不修改。
  • 传 0：未分类。
  • 传分类 ID：设置为对应分类。通过 CreateVideoClassification 创建分类 ID。
ExpireTime
String
否
2024-08-30T20:10:11+08:00

视频文件过期时间。过期后该 Vid 对应的视频文件及其相关资源（转码产物、封面图等）将被永久删除。采用 ISO 日期格式。取值说明如下：

  • 不传或传空：不修改过期时间。
  • 传 9999-12-31T23:59:59Z：永不过期。

说明

  • 如果您配置了媒资删除完成事件通知，Vid 过期被删除时，您将收到通知。
  • 亚太东南（柔佛）地域暂不支持此参数。

返回参数

本接口无特有的返回参数。具体请见公共返回参数。

请求示例

https://vod.volcengineapi.com?Action=UpdateMediaInfo&Version=2020-08-01&Vid=v03c24g100***ps1v0vcd6b5r1g&PosterUri=tos-vod-cn-v-03***112705/hello vod_cover&Title=视频&Description=视频测试&Tags=01&ClassificationId=001

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2020112416******107034080031B5",
    "Action": "UpdateMediaInfo",
    "Version": "2020-08-01",
    "Service": "vod",
    "Region": "cn-north-1"
  }
}

错误码

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

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API。此 API 各语言调用的示例代码，请参考如下：