tencent cloud



Last updated: 2023-11-29 10:56:17

    1. API Description

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

    • After a media file is forbidden, except previewing it in the VOD Console, accessing the URLs of its various resources (such as source file, output files, and screenshots) in other scenarios will return error 403.
      It takes about 5-10 minutes for a forbidding/unblocking operation to take effect across the entire network.

    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 List of media files. Up to 20 ones can be submitted at a time.
    Operation Yes String forbid: forbids, recover: unblocks.
    SubAppId No Integer The VOD subapplication ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty.

    3. Output Parameters

    Parameter Name Type Description
    NotExistFileIdSet Array of String List of IDs of files that do not exist.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Disabling the playback of certain media files

    Input Example

    &<Common request parameters>

    Output Example

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

    5. Developer Resources


    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 Invalid parameter.
    InvalidParameterValue.FileIdsTooMany Incorrect parameter value: too many FileId
    InvalidParameterValue.Operation Incorrect parameter value: invalid Operation.
    UnauthorizedOperation Unauthorized operation.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support