删除媒体

最近更新时间:2024-04-16 01:23:58

我的收藏

1. 接口描述

接口请求域名: vod.tencentcloudapi.com 。

  • 删除媒体及其对应的视频处理文件(原始文件、如转码视频、雪碧图、截图、微信发布视频等);
  • 可单独删除指定 ID 的视频文件下的原文件、转码视频、微信发布视频等;
  • 注意:原文件删除后,无法发起转码、微信发布等任何视频处理操作。

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DeleteMedia。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,此参数为可选参数。
FileId String 媒体文件的唯一标识。
示例值:7447398156998994860
SubAppId Integer 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
示例值:1
DeleteParts.N Array of MediaDeleteItem 指定本次需要删除的部分。默认值为 "[]", 表示删除媒体及其对应的全部视频处理文件。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 删除媒体文件

视频文件不需要保存,删除该FileId下全部文件和信息。

输入示例

https://vod.tencentcloudapi.com/?Action=DeleteMedia
&FileId=7447398156998994860
&SubAppId=1
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "requestId"
    }
}

示例2 删除部分转码视频

只想删除部分defination的转码视频,保留其他格式的转码视频。
例如删除转码defination为230的HLS文件,并且同时删除HLS Master Playlist

输入示例

https://vod.tencentcloudapi.com/?Action=DeleteMedia
&FileId=7447398156998994860
&SubAppId=1
&DeleteParts.0.Type=TranscodeFiles
&DeleteParts.0.Definition=230
&DeleteParts.1.Type=TranscodeFiles
&DeleteParts.1.Definition=10000
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "requestId"
    }
}

示例3 删除转码视频和微信发布视频

删除指定FileId下的全部转码文件及微信发布文件。
保留源文件,保留转码和截图等其他任务流生成的文件和信息。

输入示例

https://vod.tencentcloudapi.com/?Action=DeleteMedia
&FileId=7447398156998994860
&SubAppId=1
&DeleteParts.0.Type=TranscodeFiles
&DeleteParts.1.Type=WechatPublishFiles
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "requestId"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
FailedOperation.InvalidVodUser 没有开通点播业务。
InternalError 内部错误。
ResourceNotFound 资源不存在。
UnauthorizedOperation 未授权操作。