UpdateDomainConfig

Last updated: 2020-07-31 11:15:02

1. API Description

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

This API is used to update the configuration information of an ECDN acceleration domain name.
Note: if you need to update a complex configuration item, you must pass in all attributes of the entire object, and the default values will be used for the attributes that are not passed in. You are recommended to get the configuration attribute through the query API first and then directly modify and pass it to this API. Due to the special nature of the certificate for HTTPS configuration, you do not need to pass in the certificate and key fields during the update.

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: UpdateDomainConfig.
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 No Origin Origin server configuration.
ProjectId No Integer Project ID.
IpFilter No IpFilter IP blocklist/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.
Area No String Domain name acceleration region. Valid values: mainland (acceleration in Mainland China), overseas (acceleration outside Mainland China), global (global acceleration).

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 Updating domain name configuration

Input Example

https://ecdn.tencentcloudapi.com/?Action=UpdateDomainConfig
&ProjectId=0
&Domain=www.test.com
&<Common request parameters>

Output Example

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

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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
InternalError.EcdnSystemError System error. Please submit a ticket for troubleshooting.
InvalidParameter.EcdnInterfaceError Internal API error. Please submit a ticket for troubleshooting.
InvalidParameter.EcdnInvalidParamArea Invalid Area parameter. Please see the sample parameters in the documentation.
InvalidParameter.EcdnParamError Parameter error. Please see the sample parameters in the documentation.
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.EcdnProjectNotExists The project does not exist.
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.EcdnDomainUnauthorized The acceleration domain name is not authorized for the ECDN sub-account.
UnauthorizedOperation.EcdnUserIsSuspended The acceleration service has been suspended. Please restart it and try again.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help