tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyZone

Last updated: 2024-12-16 16:39:22

    1. API Description

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

    This API is used to modify a site.

    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: ModifyZone.
    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 The site ID.
    Type No String Site access method. Valid values:
  • full: NS access.
  • partial: CNAME access. If the site is currently accessed with no domain name, it can be switched only to CNAME access.
  • dnsPodAccess: DNSPod hosted access. To use this access mode, your domain name should have been hosted on DNSPod.
    • If this parameter is not input, the original configuration is maintained.
    VanityNameServers No VanityNameServers The custom name servers. The original configuration applies if this field is not specified. It is not allowed to pass this field when a site is connected without using a domain name.
    AliasZoneName No String The site alias. It can be up to 20 characters consisting of digits, letters, hyphens (-) and underscores (_).
    Area No String The region where the site requests access. Values:
  • global: Global coverage
  • mainland: Chinese mainland
  • overseas: Outside the Chinese mainland
    • It is not allowed to pass this field when a site is connected without using a domain name.
    ZoneName No String Name of the site. This field takes effect only when the site switches from domainless access to CNAME access.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Modifying a site

    This example shows you how to modify a site.

    Input Example

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

{
    "VanityNameServers": {
        "Switch": "on",
        "Servers": [
            "ns1.example.com",
            "ns2.example.com"
        ]
    },
    "Type": "full",
    "ZoneId": "zone-27q0p0bali16",
    "AliasZoneName": "zone-example"
}

    Output Example

    {
    "Response": {
        "RequestId": "4ac50b24-7dc2-47f4-92ce-9fd25d53gt2f"
    }
}

    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
    DryRunOperation DryRun operation, which means the DryRun parameter is passed in yet the request will still be successful.
    FailedOperation Operation failed.
    FailedOperation.FailedToCallDNSPod
    InternalError.ConfigLocked The configuration is locked. Please unlock and try again.
    InvalidParameter.InvalidOriginIp The origin cannot be a private IP or loopback address.
    InvalidParameter.InvalidWebSocketTimeout Invalid WebSocket.
    InvalidParameter.LengthExceedsLimit Maximum parameter length exceeded.
    InvalidParameter.ZoneNameIsRequired To switch a site from connecting without a domain name to connecting via the CNAME, the site name is required.
    InvalidParameterValue Invalid parameter value.
    InvalidParameterValue.ZoneSameAsName The site alias already exists.
    OperationDenied Operation denied.
    OperationDenied.DNSPodUnauthorizedRoleOperation The TEO_QCSLinkedRoleInDnspodAccessEO role is not authorized. Please authorize it and try again.
    OperationDenied.DisableZoneNotCompleted The EdgeOne service of the site is being disabled. Please try again later.
    OperationDenied.DomainInShareCnameGroup Switch failed: There are domain names in the shared CNAME group.
    OperationDenied.DomainNumberIsNotZero Unable to modify the service area: There are domain names under the site.
    OperationDenied.ErrZoneIsAlreadyPaused The EdgeOne service of the site is disabled. Please enable it and try again.
    OperationDenied.MultipleCnameZone Unable to switch to NS for multiple sites using CNAME.
    OperationDenied.NSNotAllowTrafficStrategy Domain traffic scheduling is not supported in NS access mode.
    OperationDenied.NoDomainAccessZoneOnlyAllowModifiedToCNAME You can only switch a site connected without a domain name to connecting via the CNAME
    OperationDenied.NoDomainAccessZoneOnlySupportModifyType You can only switch a site connected without a domain name to connecting via the CNAME. Other operations are not allowed.
    OperationDenied.PlanNotSupportModifyZoneArea The specified plan does not support changing the service area of the site.
    OperationDenied.ResourceLockedTemporary This operation conflicts with concurrent operations. Try again later.
    ResourceInUse.Cname Resources occupied by this account via CNAME.
    ResourceInUse.Dns DNS resources occupied.
    ResourceInUse.GenericHost Resources occupied by the wildcard domain name.
    ResourceInUse.NS Resources occupied by this account via NS.
    ResourceInUse.Others The resource has been connected to EdgeOne by another user.
    ResourceInUse.OthersAliasDomain Resources occupied by the alias domain names under other accounts.
    ResourceInUse.OthersCname Resources occupied by other accounts via CNAME.
    ResourceInUse.OthersNS Resources occupied by other accounts via NS.
    ResourceInUse.SelfAndOthersCname Resources occupied by this account and others via CNAME.
    ResourceNotFound The resource doesn’t exist.
    ResourceNotFound.DNSPodDomainNotInAccount The domain name is not properly accessed via DNSPod. Please try again after DNSPod access.
    ResourceUnavailable The resource is unavailable.
    UnauthorizedOperation.CamUnauthorized CAM is not authorized.
    UnauthorizedOperation.NoPermission The sub-account is not authorized for the operation. Please get permissions first.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy