tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateVodDomain

Last updated: 2024-11-27 16:39:22

    1. API Description

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

    This API is used to add an acceleration domain name to VOD. One user can add up to 20 domain names.

    1. After a domain name is added, VOD will deploy it, and it takes about 2 minutes for the domain name status to change from Deploying to 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: CreateVodDomain.
    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 to add to VOD. Note: a wildcard domain name is not supported.
    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.
    AccelerateArea No String Region to enable acceleration. Valid values:
  • Chinese Mainland
  • Outside Chinese Mainland
  • Global

    • If AccelerateArea is not specified, VOD will enable acceleration in or outside Chinese mainland based on the regional information a user has configured with Tencent Cloud.
    Type No String Domain type. Valid values:
  • VOD: Domain name distributed using the VOD product;
  • EdgeOne: Domain name distributed using the EdgeOne product.
    • default value: VOD.

    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 CreateVodDomain

    CreateVodDomain

    Input Example

    https://vod.intl.tencentcloudapi.com/?Action=CreateVodDomain
&Domain=myexample.com
&<Public Request Parameter>

    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
    AuthFailure CAM signature/authentication error.
    FailedOperation Operation failed.
    FailedOperation.InvalidAccount User account exception.
    FailedOperation.InvalidVodUser The VOD service is not activated.
    InvalidParameter Invalid parameter.
    InvalidParameterValue.DomainNameInBlackList This domain name cannot be added as it is invalid.
    UnauthorizedOperation.DomainRecordNotVerified
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy