tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

UpdateDomainConfig

Last updated: 2022-02-25 18:33:55

    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 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.

    Note：

    If your application has been migrated to Tencent Cloud CDN, you can use CDN APIs.

    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.
    This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

    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).
    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 Updating domain name configurations

    Input Example

    https://ecdn.tencentcloudapi.com/?Action=UpdateDomainConfig
&ProjectId=0
&Domain=www.test.com
&

    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.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.
    ResourceUnavailable.EcdnDomainIsLocked The domain name has been locked. Please submit a ticket.
    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.EcdnMigratedCdn Please go to the CDN console for operation.
    UnauthorizedOperation.EcdnProjectUnauthorized The project is not authorized 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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy