AddEcdnDomain

Last updated: 2021-01-29 10:17:16

1. API Description

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

This API is used to create an acceleration domain name.

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: AddEcdnDomain.
Version Yes String Common parameter. The value used for this API: 2019-10-12.
Region No String Common parameter. This parameter is not required for this API.
Domain Yes String Domain name.
Origin Yes Origin Origin server configuration.
Area Yes String Domain name acceleration region. Valid values: mainland (acceleration in Mainland China), overseas (acceleration outside Mainland China), global (global acceleration).
ProjectId No Integer Project ID. Default value: 0.
IpFilter No IpFilter IP block/allowlist configuration.
IpFreqLimit No IpFreqLimit IP access limit configuration.
ResponseHeader No ResponseHeader Origin server response header configuration.
CacheKey No CacheKey Node caching configuration.
Cache No Cache Caching rule configuration.
Https No Https HTTPS configuration.
ForceRedirect No ForceRedirect Forced access protocol redirection configuration.
Tag.N No Array of Tag Tag bound to a domain name.
WebSocket No WebSocket WebSocket 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

Example1 Adding an acceleration domain name

Input Example

https://ecdn.tencentcloudapi.com/?Action=AddEcdnDomain
&Domain=www.test.com
&Origin.Origins.0=2.2.2.2
&Area=global
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "23cd4005-496f-4bc4-87d8-ab348d5b0c17"
  }
}

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.EcdnConfigError Failed to update the domain name configuration. Please try again or contact customer service for assistance.
InternalError.EcdnConfigError Internal configuration service error. Please try again later or contact the customer service for assistance.
InternalError.EcdnDbError Internal data error. Please submit a ticket for troubleshooting.
InternalError.EcdnSystemError System error. Please submit a ticket for troubleshooting.
InvalidParameter.EcdnCamTagKeyNotExist The tag key does not exist.
InvalidParameter.EcdnInterfaceError Internal API error. Please submit a ticket for troubleshooting.
InvalidParameter.EcdnParamError Parameter error. Please see the sample parameters in the documentation.
InvalidParameter.EcdnResourceManyTagKey This domain name binds too many tag keys.
InvalidParameter.EcdnTagKeyInvalid Invalid tag key.
InvalidParameter.EcdnTagKeyNotExist The tag key does not exist.
InvalidParameter.EcdnTagKeyTooManyValue The tag key has too many values.
InvalidParameter.EcdnTagValueInvalid Invalid tag value.
InvalidParameter.EcdnUserTooManyTagKey This user has too many tag keys.
LimitExceeded.EcdnDomainOpTooOften Domain name operations are too frequent.
ResourceInUse.EcdnOpInProgress The ECDN resource is being manipulated.
ResourceNotFound.EcdnDomainNotExists This domain name does not exist under the account. Please check and try again.
ResourceNotFound.EcdnUserNotExists The ECDN service has not been activated. Please activate it first before using this API.
UnauthorizedOperation.EcdnCamUnauthorized No CAM policy is configured for the sub-account.
UnauthorizedOperation.EcdnUserIsSuspended The acceleration service has been suspended. Please restart it and try again.
UnauthorizedOperation.EcdnUserNoWhitelist You are not on the beta allowlist and thus have no permission to use this feature.