tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyEventConfig

Last updated: 2024-09-24 17:24:26

    1. API Description

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

    Tencent Cloud VOD provides customers with media upload, media management, media processing and other services. During or at the end of the execution of these services, Tencent Cloud On-Demand also provides various corresponding event notifications to facilitate developers to perceive the service processing status and Do the next business operation.

    Developers can achieve this by calling this interface:

    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: ModifyEventConfig.
    Version Yes String Common Params. The value used for this API: 2018-07-17.
    Region No String Common Params. This parameter is not required.
    Mode No String How to receive event notifications.
  • PUSH: HTTP callback notification;
  • PULL: Reliable notification based on message queue .
    • NotificationUrl No String The address used to receive 3.0 format callbacks when using the HTTP callback notification reception method.
    Note: If the NotificationUrl parameter is provided and the value is an empty string, the 3.0 format callback address will be cleared.
    UploadMediaCompleteEventSwitch No String Whether to receive the Video Upload Completed event notification. The default "OFF" is to ignore the event notification, and "ON" is to receive the event notification.
    DeleteMediaCompleteEventSwitch No String Whether to receive Video deletion completed event notification, the default "OFF" means to ignore the event notification, "ON" means to receive the event notification .
    PersistenceCompleteEventSwitch No String Whether to receive the Persistence completed event notification, the default "OFF" means to ignore the event notification, "ON" means to receive the event notification.
    SubAppId No Integer The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.

    3. Output Parameters

    Parameter Name Type Description
    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 Set event notification information

    Input Example

    https://vod.tencentcloudapi.com/?Action=ModifyEventConfig
&Mode=PUSH
&NotificationUrl=http://mydemo.com/receiveevent
&UploadMediaCompleteEventSwitch=ON
&<Public Request Parameter>

    Output Example

    {
    "Response": {
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

    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.
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    UnauthorizedOperation Unauthorized operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy