删除完整媒资--视频点播-火山引擎

文档中心

立即注册

导航

删除完整媒资

最近更新时间：2024.06.06 17:09:21首次发布时间：2021.04.11 11:01:30

此接口用于删除指定 Vid（视频 ID）对应的完整媒资信息，包括您上传的片源、媒资处理输出的媒体文件、封面图等。

使用说明

此接口调用成功后，系统将生成异步删除的任务。您可以配置媒资删除完成回调通知，开启后每个 Vid 删除完成您将收到回调消息。配置方法详见事件通知概览。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	`DeleteMedia`	接口名称。当前 API 的名称为 `DeleteMedia`。
Version	String	是	`2020-08-01`	接口版本。当前 API 的版本为 `2020-08-01`。
Vids	String	是	`v0dc24g1000***ps1v0lve1gj96g`	视频 ID 列表。多个 Vid 以英文逗号 `,` 隔开。单次最多支持 20 个。
CallbackArgs	String	否	`YourCallbackArgs`	您可自定义的字段，回调时会透传返回。在处理回调消息时自己解析使用。最大长度 512 字节。

返回参数

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

参数	类型	示例值	描述
NotExistVids	String[]	`["v0dc24g10001cm***s1v0lve1gj96g"]`	不存在的视频 ID 列表。

请求示例

https://vod.volcengineapi.com?Action=DeleteMedia&Version=2020-08-01&Vids=v0dc24g1000***ps1v0lve1gj96g&CallbackArgs=YourCallbackArgs

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20231221110***3E9E4559519176E9E",
    "Action": "DeleteMedia",
    "Version": "2020-08-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "NotExistVids": [
      "v0dc24g10001c***1v0lve1gj96g"
    ]
  }
}

错误码

下表列举了本接口特有的错误码。如需了解更多错误码，详见视频点播公共错误码。

状态码	错误码	错误信息	说明
400	InvalidParameter.ItemLimitExceeded	-	输入的 `Vid` 个数大于限定数 20。

服务端 SDK

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