tencent cloud

APIs

文档APIsVideo on DemandMedia Management APIsForbidMediaDistribution

ForbidMediaDistribution

Download
聚焦模式
字号
最后更新时间： 2026-05-19 15:02:04

1. API Description

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

After media blocking is enabled, all URLs for accessing various resources (raw file, transcoding output file, screenshot, etc.) will return 403 except for vod console preview.
The unblock operation takes effect across the entire network in approximately 5-10 minutes.

  • Note: Banned media can only operate standard storage and infrequent storage media. Infrequent storage media must be stored for at least 30 days. Early deletion or changing the storage class will still be billed for 30 days. If infrequent storage media is banned and its infrequent access storage period is less than 30 days, early deletion billing will occur. Meanwhile, the infrequent access storage duration of the banned media will restart from the current system time. If the media is deleted or its storage class is changed within 30 days, early deletion billing will also occur. For example: Media 001 has been in infrequent storage for 10 days. At this point, if 001 is banned, the infrequent storage billing will still be calculated for 30 days (early deletion billing duration is 30 - 10 = 20 days). After the ban, the infrequent access storage duration of 001 restarts. If 001 is deleted on the 5th day after the ban, the infrequent storage billing will also be calculated for 30 days (early deletion billing duration is 30 - 5 = 25 days). The actual infrequent access storage duration of 001 is 10 + 5 = 15 days, while the infrequent storage billing duration is 10 + 20 (early deletion billing) + 5 + 25 (early deletion billing) = 60 days.

A maximum of 20 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 Params. The value used for this API: ForbidMediaDistribution.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
FileIds.N Yes Array of String Media file list, up to 20 entries are submittable each time.
Operation Yes String forbid: block, recover: unblock.
SubAppId No Integer On-demand application ID. Customers who activate on-demand services from December 25, 2023 must fill this field with the app ID when accessing resources in on-demand applications (whether default or newly created).

3. Output Parameters

Parameter Name Type Description
NotExistFileIdSet Array of String Non-existent file ID list.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Disabling the playback of certain media files

Input Example

https://vod.intl.tencentcloudapi.com/?Action=ForbidMediaDistribution
&FileIds.0=7447398156998994860
&SubAppId=1
&Operation=forbid
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "12ae8d8e-dce3-4151-1d4b-5594145287e1",
        "NotExistFileIdSet": []
    }
}

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 Operation failed.
FailedOperation.InvalidVodUser The VOD service is not activated.
FailedOperation.MediaForbidedBySystem Media blocked by the system.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameterValue.FileIdsTooMany Incorrect parameter value: too many FileId
InvalidParameterValue.Operation Incorrect parameter value: invalid Operation.
LimitExceeded Quota limit is exceeded.
UnauthorizedOperation Unauthorized operation.
上一篇: DeleteMedia下一篇: ModifyMediaInfo

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈