tencent cloud

云点播

ForbidMediaDistribution

下载
聚焦模式
字号
最后更新时间: 2026-09-18 16:50:35

1. API Description

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

After media blocking, except for VOD console preview, accessing video resource URLs (raw files, transcoding output files, screenshots, etc.) for other scenarios will return 403.
It takes about 5 to 10 minutes for the block/unblock operation to take effect across the entire network.

  • Note: Blocking media can only operate on media in standard storage and infrequent storage. Media in infrequent storage must be stored for at least 30 days. If deleted early or changed to another storage class, it is still billed for 30 days. If you block media in infrequent storage and its infrequent storage duration is less than 30 days, early deletion billing occurs. At the same time, after blocking, the infrequent storage duration of the media restarts from the current time. If the media is deleted or changed to another storage class before reaching 30 days, early deletion billing also occurs. For example, media 001 has been in infrequent storage for 10 days. If you block 001 at this point, infrequent storage is still billed for 30 days (early deletion billing duration: 30 - 10 = 20 days). After blocking, the infrequent storage duration of 001 restarts. If 001 is deleted on day 5 after blocking, infrequent storage is still billed for 30 days (early deletion billing duration: 30 - 5 = 25 days). The actual infrequent storage duration of 001 is 10 + 5 = 15 days, and 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. A maximum of 20 entries can be submitted each time.
Operation Yes String forbid: forbid. recover: unblock.
SubAppId No Integer VOD application ID. For customers who activate VOD services after December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications (whether the default application or a newly created application).

3. Output Parameters

Parameter Name Type Description
NotExistFileIdSet Array of String List of non-existent file IDs.
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 Disable playback

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 is banned by the system.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameterValue.FileIdsTooMany Parameter value error: too many FileIds.
InvalidParameterValue.Operation Parameter value error: Operation is invalid.
LimitExceeded The quota limit is exceeded.
UnauthorizedOperation Unauthorized operation.

帮助和支持

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

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

文档反馈