tencent cloud

Feedback

ModifyAccelerationDomain

Last updated: 2024-02-21 20:20:17

    1. API Description

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

    This API is used to modify an accelerated 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 Params. The value used for this API: ModifyAccelerationDomain.
    Version Yes String Common Params. The value used for this API: 2022-09-01.
    Region No String Common Params. This parameter is not required.
    ZoneId Yes String ID of the site related with the accelerated domain name.
    DomainName Yes String Accelerated domain name
    OriginInfo No OriginInfo Details of the origin.
    OriginProtocol No String Origin-pull protocol configuration. Values:
  • FOLLOW: Follow the protocol of origin
  • HTTP: Send requests to the origin over HTTP
  • HTTPS: Send requests to the origin over HTTPS
  • The original configuration applies if this field is not specified.
  • HttpOriginPort No Integer Ports for HTTP origin-pull requests. Range: 1-65535. It takes effect when OriginProtocol=FOLLOW/HTTP. The original configuration is used if it's not specified.
    HttpsOriginPort No Integer Ports for HTTPS origin-pull requests. Range: 1-65535. It takes effect when OriginProtocol=FOLLOW/HTTPS. The original configuration is used if it's not specified.
    IPv6Status No String IPv6 status. Values:
  • follow: Follow the IPv6 configuration of the site
  • on: Enable
  • off: Disable
  • The original configuration applies if this field is not specified.
  • 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 an accelerated domain name

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyAccelerationDomains

    {
    "DomainName":"qq.com",
    "ZoneId":"zone-225qgrnvbi9w",
    "OriginInfo":{
    "OriginType":"ip_domain",
    "Origin":"qq.com"
    }
    }

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyAccelerationDomain
    <Common request parameters>
    
    {
        "DomainName": "example.com",
        "ZoneId": "zone-225qgrnvbi9w",
        "OriginInfo": {
            "OriginType": "ip_domain",
            "Origin": "qq.com",
            "BackupOrigin": ""
        }
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"
        }
    }
    

    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 Operation failed.
    InternalError.ConfigLocked The configuration is locked. Please unlock and try again.
    InternalError.SystemError Internal system error.
    InvalidParameter.ConflictHostOrigin The origin cannot be the same as the domain name.
    InvalidParameter.InvalidAwsRegion Invalid region. Please fill in a correct region of the third-party object storage service.
    InvalidParameter.InvalidAwsSecretKey Invalid third-party object storage.
    InvalidParameter.InvalidClientIpOrigin Invalid origin for region-specific origin-pull.
    InvalidParameter.InvalidHttps Invalid parameter "https".
    InvalidParameter.InvalidOrigin Invalid origin server.
    InvalidParameter.InvalidOriginIp The origin cannot be a private IP or loopback address.
    InvalidParameter.InvalidPrivateAccessParams AccessKeyId and SecretAccessKey are required to access the third-party object storage.
    InvalidParameter.InvalidRangeOriginPull Invalid Range GETs.
    InvalidParameter.InvalidStandardDebugClientIp Invalid client IP or CIDR block.
    InvalidParameter.InvalidWebSocketTimeout Invalid WebSocket.
    InvalidParameter.OriginIsInnerIp The origin address cannot be a private IP address.
    InvalidParameter.SpaceNotBindOrigin Shield Space is not bound with an origin.
    InvalidParameter.ZoneIsGrayPublishing The site is being upgraded. Changing is not supported. Please try again later.
    InvalidParameterValue.ConflictRecord It conflicts with existing records.
    InvalidParameterValue.DomainNotMatchZone The specified domain name does not match the site.
    InvalidParameterValue.InvalidDomainStatus Invalid domain name. Please check the status.
    OperationDenied.DomainNoICP The domain name doesn't have an ICP filing number.
    OperationDenied.ResourceLockedTemporary This operation conflicts with concurrent operations. Try again later.
    OperationDenied.VersionControlIsGraying There is a test version in use. Please release the test version to the live environment, or roll back the test version and try again.
    ResourceInUse The resource is occupied.
    ResourceInUse.DnsRecord The domain name is being resolved. If you need to enable acceleration, please go to DNS Records.
    ResourceUnavailable.DomainNotFound The requested accelerated domain name doesn’t exist.
    UnauthorizedOperation.CamUnauthorized CAM is not authorized.
    UnauthorizedOperation.NoPermission The sub-account is not authorized for the operation. Please get permissions first.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support