DeleteMedia

Last updated: 2020-11-24 18:54:18

1. API Description

Domain name for API request: vod.tencentcloudapi.com.

  • This API is used to delete a media file and its corresponding files generated by video processing (such as transcoded videos, image sprites, screenshots, and videos published on WeChat);
  • The transcoded video files or video files published on WeChat can be deleted separately for a specified video ID.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DeleteMedia.
Version Yes String Common parameter. The value used for this API: 2018-07-17.
Region No String Common parameter. This parameter is not required for this API.
FileId Yes String Unique media file ID.
DeleteParts.N No Array of MediaDeleteItem Content to be deleted. The default value is "[]", which indicates to delete the media file and all its corresponding files generated by video processing.
SubAppId No Integer Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Deleting media files

This example shows you how to delete all files and information under a specified FileId when the video files do not need to be retained.

Input Example

https://vod.tencentcloudapi.com/?Action=DeleteMedia
&FileId=7447398156998994860
&SubAppId=1
&<Public request parameters>

Output Example

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

Example2 Deleting transcoded videos and videos published on WeChat

This example shows you how to delete all the transcoded video files and video files published on WeChat under a specified FileId.
The source file and other files and information generated by other task flows such as transcoding and screencapturing will be retained.

Input Example

https://vod.tencentcloudapi.com/?Action=DeleteMedia
&FileId=7447398156998994860
&SubAppId=1
&DeleteParts.0.Type=TranscodeFiles
&DeleteParts.1.Type=WechatPublishFiles
&<Public request parameters>

Output Example

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

Example3 Deleting certain transcoded videos

This example shows you how to delete transcoded videos in certain definitions and retain the rest ones.
For example, you can delete both the HLS file in the transcoding definition of 230 and the HLS Master Playlist.

Input Example

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
&<Public request parameters>

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.InvalidVodUser The VOD service is not activated.
InternalError Internal error.
ResourceNotFound The resource does not exist.
UnauthorizedOperation Unauthorized operation.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help