You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /视频点播/API 参考/媒资管理/删除媒体处理输出文件
删除媒体处理输出文件
最近更新时间：2024.06.06 19:29:02首次发布时间：2021.04.11 11:01:30
我的收藏

此接口用于在不删除片源的情况下，删除指定 Vid（视频 ID）下的媒体处理输出文件。

使用说明

  • 此接口可删除全部或部分媒体处理输出文件。如果您只想删除部分文件，您需要先通过获取媒资信息接口获取待删除的媒体文件对应的 FileId。
  • 此接口调用成功后，系统将生成异步删除的任务。您可以开启媒体处理输出文件删除完成回调通知。开启后每个 FileId 删除完成后您都会收到回调消息。配置方法详见事件通知概览。

请求说明

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

调试

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

请求参数

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

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

视频 ID。只支持单个 Vid。获取的方式如下所示。

FileIds
String
否

媒体处理输出文件 ID 列表。多个 FileId 以英文逗号 , 隔开，最多 20 个。若未传入或传入长度为 0，则系统删除 Vid 下所有媒体文件。

注意

FileId 里不能包含片源对应的 FileId。如果要删除包含片源在内的所有视频，请使用删除完整媒资接口。

CallbackArgs
String
否
YourCallbackArgs
您可自定义的字段，回调时会透传返回。在处理回调消息时自己解析使用。最大长度 512 字节。

返回参数

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

参数
类型
示例值
描述
NotExistFileIds
String[]
[]
不存在的转码文件 ID 的列表。

请求示例

https://vod.volcengineapi.com?Action=DeleteTranscodes&Version=2020-08-01&Vid=v02c24g10001cm1qt6ps1v0q66n2o2h0&FileIds=&CallbackArgs=YourCallbackArgs

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2023122111***84E63027C613DC49",
    "Action": "DeleteTranscodes",
    "Version": "2020-08-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "NotExistFileIds": []
  }
}

错误码

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

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

服务端 SDK

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