tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyDomainConfig

Last updated: 2023-12-01 16:39:49

    1. API Description

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

    This API is used to modify the configuration of a CDN acceleration domain name in a finer manner than UpdateDomainConfig.
    Notes:
    In Route, separate values by dots (.). The last value is called a leaf node. For non-leaf nodes, keep the configuration unchanged.
    The Value field is serialized to a JSON string {key:value}, where key is fixed to update and value is used to specify the value of the configuration parameter. To specify configurations with complex types, see https://www.tencentcloud.com/document/product/228/41116.?from_cn_redirect=1
    The input parameters of this API are not reported to CloudAudit as it may contain sensitive data, such as keys and secrets.

    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 Params. The value used for this API: ModifyDomainConfig.
    Version Yes String Common Params. The value used for this API: 2018-06-06.
    Region No String Common Params. This parameter is not required for this API.
    Domain Yes String The domain name.
    Route Yes String Name of the configuration parameter.
    Value Yes String Value of the configuration parameter. This field is serialized to a JSON string {key:value}, where key is fixed to update.

    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 Modifying the HTTPS server certificate

    This example shows you how to modify the HTTPS server certificate. A certificate ID is auto-generated when the certificate is added to Tencent Cloud SSL Certificates.

    Input Example

    POST / HTTP/1.1
Host: cdn.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDomainConfig
<Common request parameters>

{
    "Domain": "www.test.com",
    "Route": "Https.CertInfo.CertId",
    "Value": "{\"update\":\"0VpOXiPz\"}"
}

    Output Example

    {
    "Response": {
        "RequestId": "56a166ec-d784-4001-a850-7d62a5c07971"
    }
}

    Example2 Modifying the origin connection timeout threshold

    This example shows you how to modify the timeout threshold of establishing a connection with the origin.

    Input Example

    POST / HTTP/1.1
Host: cdn.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDomainConfig
<Common request parameters>

{
    "Domain": "www.test.com",
    "Route": "OriginPullTimeout.ConnectTimeout",
    "Value": "{\"update\":10}"
}

    Output Example

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

    Example3 Modifying the origin-pull timeout

    This example shows you how to modify the timeout threshold of pulling resources from the origin.

    Input Example

    POST / HTTP/1.1
Host: cdn.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDomainConfig
<Common request parameters>

{
    "Domain": "www.test.com",
    "Route": "OriginPullTimeout",
    "Value": "{\"update\":{\"ConnectTimeout\":10,\"ReceiveTimeout\":10}}"
}

    Output Example

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

    Example4 Modifying the configuration of a domain name

    This example shows how to modify the configuration of a domain name.

    Input Example

    POST / HTTP/1.1
Host: cdn.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDomainConfig
<Common request parameters>

{
    "Domain": "www.test.com",
    "Route": "Origin.Origins",
    "Value": "{\"update\":[\"1.1.1.1\"]}"
}

    Output Example

    {
    "Response": {
        "RequestId": "eb029ee0-7e91-4a18-86f3-7fac952a446e"
    }
}

    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.CdnConfigError Failed to update the domain name configuration. Please submit a ticket for troubleshooting.
    InternalError.CamSystemError Authentication system internal error.
    InternalError.CdnConfigError Failed to update the domain name configuration.
    InternalError.CdnDbError Internal data error. Please submit a ticket for troubleshooting.
    InternalError.CdnQuerySystemError Internal error. Please try again or contact the customer service for assistance.
    InternalError.CdnSystemError System error. Please submit a ticket for troubleshooting.
    InternalError.Error Service internal error. Please submit a ticket for troubleshooting.
    InternalError.InvalidErrorCode Service internal error. Please submit a ticket for troubleshooting.
    InternalError.ProxyServer Internal service error. Please submit a ticket for troubleshooting.
    InvalidParameter.AccessPortOpenedHttps The access port 443 must be enabled for HTTPS configuration.
    InvalidParameter.BandLimitRequiredMainland Please delete the rate limiting configuration before you switch the acceleration region.
    InvalidParameter.BandwidthAlertCounterMeasureConflictOriginType Tencent Cloud COS and third-party object storage origins only support "Return 404". Please modify and try again.
    InvalidParameter.CDNStatusInvalidDomain Invalid domain name status.
    InvalidParameter.CdnCertInfoNotFound The certificate information is invalid or does not exist. Please check and try again.
    InvalidParameter.CdnConfigInvalidCache Invalid cache configuration. Please check and try again.
    InvalidParameter.CdnHostInvalidMiddleConfig Incorrect intermediate server configuration.
    InvalidParameter.CdnHostInvalidStatus Invalid domain name status.
    InvalidParameter.CdnInterfaceError Internal API error. Please submit a ticket for troubleshooting.
    InvalidParameter.CdnInvalidParamServiceType Invalid field: ServiceType. Please check and try again.
    InvalidParameter.CdnKeyRulesExcludeCustomRequiresFullLego The configuration is not supported.
    InvalidParameter.CdnKeyRulesInvalidQueryStringValue Invalid field: QueryString. Please check and try again.
    InvalidParameter.CdnParamError Parameter error. Please see the sample parameters in the documentation.
    InvalidParameter.CdnStatInvalidProjectId Incorrect project ID. Please check and try again.
    InvalidParameter.CdnStatTooManyDomains The number of queried domain names reached the limit.
    InvalidParameter.PathRegexTooManySubPattern The maximum number of regex sub-patterns is exceeded.
    InvalidParameter.RemoteAuthInvalidPlatform This platform does not support remote authentication.
    InvalidParameter.RemoteAuthInvalidProtocol This platform does not support remote access to an authentication address via the HTTPS protocol.
    LimitExceeded.CdnConfigTooManyCacheRules The number of cache validity configuration rules exceeds the limit.
    LimitExceeded.CdnHostOpTooOften Domain name operations are too frequent.
    ResourceInUse.CdnHostExists Domain name already exists.
    ResourceInUse.CdnOpInProgress CDN resources are being operated.
    ResourceNotFound.CdnHostNotExists Unable to find the domain name. Please make sure the domain name is correct.
    ResourceNotFound.CdnUserNotExists The CDN service has not been activated. Please activate it first before using this API.
    ResourceNotFound.EcdnDomainNotExists The domain name does not exist. Please check and try again.
    ResourceUnavailable.CdnHostBelongsToOthersInMainland The domain name has been connected to the Mainland China service region. If you need to switch the service region to "Global", please verify its ownership for domain name retrieval.
    ResourceUnavailable.CdnHostBelongsToOthersInOverseas The domain name has been connected to the service region outside Mainland China. If you need to switch the service region to "Global", please verify its ownership for domain name retrieval.
    ResourceUnavailable.CdnHostIsLocked The domain name is locked.
    ResourceUnavailable.CdnHostIsNotOffline Domain name is still in use.
    ResourceUnavailable.CdnHostNoIcp ICP filing is required for the domain name and the synchronization takes 2 hours. If it is already filed, please try later.
    UnauthorizedOperation.CdnCamUnauthorized No CAM policy is configured for the sub-account.
    UnauthorizedOperation.CdnHostInIcpBlacklist The domain name is not compliant and cannot be connected.
    UnauthorizedOperation.CdnHostUnauthorized The sub-account has no access to the CDN-accelerated domain name.
    UnauthorizedOperation.CdnProjectUnauthorized The project is not authorized for the sub-account.
    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.CdnUserIsIsolated The account has been isolated due to arrears. Please pay the bill and try again.
    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.
    UnauthorizedOperation.OperationTooOften Too many calling attempts.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy