tencent cloud

Feedback

ModifyVodDomainConfig

Last updated: 2024-01-02 12:24:13

    1. API Description

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

    This API is used to modify domain name settings, such as the hotlink protection configuration.

    1. You can modify settings of only domain names whose status is Online.

    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: ModifyVodDomainConfig.
    Version Yes String Common Params. The value used for this API: 2018-07-17.
    Region No String Common Params. This parameter is not required.
    Domain Yes String Domain name
    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.
    RefererAuthPolicy No RefererAuthPolicy Referer hotlink protection policy
    UrlSignatureAuthPolicy No UrlSignatureAuthPolicy Key hotlink protection policy
    QUICConfig No DomainQUICConfig The QUIC configuration.

    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

    This example shows you how to enable key hotlink protection for a domain.

    Input Example

    https://vod.tencentcloudapi.com/?Action=ModifyVodDomainConfig
    &Domain=myexample.com
    &UrlSignatureAuthPolicy.Status=Enabled
    &UrlSignatureAuthPolicy.EncryptedKey=xxxx
    &<Common request parameters>
    

    Output Example

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

    This example shows you how to enable referer hotlink protection for a domain.

    Input Example

    https://vod.tencentcloudapi.com/?Action=ModifyVodDomainConfig
    &Domain=myexample.com
    &RefererAuthPolicy.Status=Enabled
    &RefererAuthPolicy.AuthType=Black
    &RefererAuthPolicy.Referers.0=example.com
    &RefererAuthPolicy.BlankRefererAllowed=Yes
    &<Common request parameters>
    

    Output Example

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

    Example3 Enabling QUIC for a domain

    This example shows you how to enable QUIC for a domain.

    Input Example

    https://vod.tencentcloudapi.com/?Action=ModifyVodDomainConfig
    &Domain=myexample.com
    &QUICConfig.Status=Enabled
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "RequestId": "12ae8d8e-dce3-4551-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.DomainDeploying You cannot modify the settings of the domain name as it is being deployed.
    InvalidParameter Invalid parameter.
    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