Help & DocumentationContent Delivery NetworkAPI Documentation Configuration Management APIsUpdateDomainConfig
Contents：
1. API Description
Domain name for API request: cdn.tencentcloudapi.com.
This API is used to modify the configuration of CDN acceleration domain names.
Note: if you need to update complex configuration items, you must pass all the attributes of the entire object. The default value will be used for attributes that are not passed. We recommend calling the querying API to obtain the configuration attributes first. You can then modify and pass the attributes to the API. The certificate and key fields do not need to be passed for HTTPS configuration.
A maximum of 20 requests can be initiated per second for this API.
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: 2018-06-06. |
| Region | No | String | Common parameter. This parameter is not required for this API. |
| Domain | Yes | String | Domain name |
| ProjectId | No | Integer | Project ID |
| Origin | No | Origin | Origin server configuration |
| IpFilter | No | IpFilter | IP blacklist/whitelist configuration |
| IpFreqLimit | No | IpFreqLimit | IP access limit configuration |
| StatusCodeCache | No | StatusCodeCache | Status code cache configuration |
| Compression | No | Compression | Smart compression configuration |
| BandwidthAlert | No | BandwidthAlert | Bandwidth cap configuration |
| RangeOriginPull | No | RangeOriginPull | Range GETs configuration |
| FollowRedirect | No | FollowRedirect | 301/302 origin-pull follow-redirect configuration |
| ErrorPage | No | ErrorPage | Error code redirect configuration (This feature is in beta and not generally available yet.) |
| RequestHeader | No | RequestHeader | Request header configuration |
| ResponseHeader | No | ResponseHeader | Response header configuration |
| DownstreamCapping | No | DownstreamCapping | Download speed configuration |
| CacheKey | No | CacheKey | Node cache key configuration |
| ResponseHeaderCache | No | ResponseHeaderCache | Header cache configuration |
| VideoSeek | No | VideoSeek | Video dragging configuration |
| Cache | No | Cache | Cache expiration time configuration |
| OriginPullOptimization | No | OriginPullOptimization | Cross-border linkage optimization configuration |
| Https | No | Https | HTTPS acceleration configuration |
| Authentication | No | Authentication | Timestamp hotlink protection configuration |
| Seo | No | Seo | SEO configuration |
| ForceRedirect | No | ForceRedirect | Access protocol forced redirect configuration |
| Referer | No | Referer | Referer hotlink protection configuration |
| MaxAge | No | MaxAge | Browser cache configuration (This feature is in beta and not generally available yet.) |
| ServiceType | No | String | Domain name service type web: static acceleration download: download acceleration media: streaming media VOD acceleration |
| SpecificConfig | No | SpecificConfig | Specific region configuration Applicable to cases where the acceleration domain name configuration differs for regions in and outside mainland China. |
| Area | No | String | Domain name acceleration region mainland: acceleration inside mainland China overseas: acceleration outside mainland China global: global acceleration |
| OriginPullTimeout | No | OriginPullTimeout | Origin-pull timeout configuration |
| AwsPrivateAccess | No | AwsPrivateAccess | Origin access authentication for S3 bucket |
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 a domain name configuration
Input Example
https://cdn.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.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
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.CdnConfigError | Failed to update the domain name configuration. Please try again or contact customer service. |
| InternalError.CdnConfigError | Failed to update the domain name configuration. |
| InternalError.CdnSystemError | System error. Please submit a ticket for troubleshooting. |
| InvalidParameter.CDNStatusInvalidDomain | Invalid domain name status. |
| InvalidParameter.CdnHostInvalidMiddleConfig | Incorrect intermediate server configuration. |
| InvalidParameter.CdnHostInvalidStatus | Invalid domain name status. |
| InvalidParameter.CdnInterfaceError | Internal API error. Please submit a ticket for troubleshooting. |
| InvalidParameter.CdnParamError | Parameter error. Please see the sample parameters in the documentation. |
| InvalidParameter.CdnStatInvalidProjectId | Incorrect project ID. Please check and try again. |
| LimitExceeded.CdnHostOpTooOften | Domain name operations are too frequent. |
| ResourceInUse.CdnOpInProgress | CDN resources are being operated. |
| ResourceNotFound.CdnHostNotExists | This domain name does not exist under the account. Please check and try again. |
| ResourceNotFound.CdnUserNotExists | The CDN service has not been activated. Please activate it first before using this API. |
| ResourceUnavailable.CdnHostIsLocked | The domain name is locked. |
| ResourceUnavailable.CdnHostIsNotOffline | Domain name is still in use. |
| UnauthorizedOperation.CdnCamUnauthorized | No CAM policy is configured for the sub-account. |
| UnauthorizedOperation.CdnHostUnauthorized | The sub-account has no access to the CDN-accelerated domain name. |
| UnauthorizedOperation.CdnProjectUnauthorized | The sub-account has no access to the project. |
| UnauthorizedOperation.CdnTagUnauthorized | The sub-account has no access to the tag. |
| UnauthorizedOperation.CdnUserAuthFail | Fail to authenticate the CDN user. |
| UnauthorizedOperation.CdnUserAuthWait | The CDN user is pending authentication. |
| UnauthorizedOperation.CdnUserIsSuspended | The CDN service has been suspended. Please restart it and try again. |
| UnauthorizedOperation.CdnUserNoWhitelist | You are not in the beta whitelist and thus have no permission to use this function. |
| UnauthorizedOperation.OpNoAuth | This operation is not supported currently. Please submit a ticket for assistance. |
