CreateVodDomain

Last updated: 2021-11-09 10:56:59

1. API Description

Domain name for API request: vod.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 parameter. The value used for this API: CreateVodDomain.
Version Yes String Common parameter. The value used for this API: 2018-07-17.
Region No String Common parameter. This parameter is not required for this API.
Domain Yes String Domain name to add to VOD. Note: a wildcard domain name is not supported.
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.
    SubAppId No Integer 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
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Adding a domain name to VOD

    Input Example

    https://vod.tencentcloudapi.com/?Action=CreateVodDomain
    &Domain=myexample.com
    &<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
    AuthFailure CAM signature/authentication error.
    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.