Overview
Menu

ModifyZone

1. API Description

Domain name for API request: teo.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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: ModifyZone.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
ZoneIdYesStringThe site ID.
TypeNoStringAccess mode of the site. Values:
  • full: Access through a name server.
  • partial: Access through a CNAME record. A site using domainless access can only switch to CNAME access.
  • The original configuration applies if this field is not specified.
    VanityNameServersNoVanityNameServersThe 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.
    AliasZoneNameNoStringThe site alias. It can be up to 20 characters consisting of digits, letters, hyphens (-) and underscores (_).
    AreaNoStringThe 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.
    ZoneNameNoStringName of the site. This field takes effect only when the site switches from domainless access to CNAME access.

    3. Output Parameters

    Parameter NameTypeDescription
    RequestIdStringThe 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.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 CodeDescription
    DryRunOperationDryRun operation, which means the DryRun parameter is passed in yet the request will still be successful.
    FailedOperationOperation failed.
    InternalError.ConfigLockedThe configuration is locked. Please unlock and try again.
    InvalidParameter.InvalidOriginIpThe origin cannot be a private IP or loopback address.
    InvalidParameter.InvalidWebSocketTimeoutInvalid WebSocket.
    InvalidParameter.LengthExceedsLimitMaximum parameter length exceeded.
    InvalidParameter.ZoneNameIsRequiredTo switch a site from connecting without a domain name to connecting via the CNAME, the site name is required.
    InvalidParameterValueInvalid parameter value.
    InvalidParameterValue.ZoneSameAsNameThe site alias already exists.
    OperationDeniedOperation denied.
    OperationDenied.DisableZoneNotCompletedThe EdgeOne service of the site is being disabled. Please try again later.
    OperationDenied.DomainInShareCnameGroupSwitch failed: There are domain names in the shared CNAME group.
    OperationDenied.DomainNumberIsNotZeroUnable to modify the service area: There are domain names under the site.
    OperationDenied.ErrZoneIsAlreadyPausedThe EdgeOne service of the site is disabled. Please enable it and try again.
    OperationDenied.MultipleCnameZoneUnable to switch to NS for multiple sites using CNAME.
    OperationDenied.NSNotAllowTrafficStrategyDomain traffic scheduling is not supported in NS access mode.
    OperationDenied.NoDomainAccessZoneOnlyAllowModifiedToCNAMEYou can only switch a site connected without a domain name to connecting via the CNAME
    OperationDenied.NoDomainAccessZoneOnlySupportModifyTypeYou can only switch a site connected without a domain name to connecting via the CNAME. Other operations are not allowed.
    OperationDenied.PlanNotSupportModifyZoneAreaThe specified plan does not support changing the service area of the site.
    OperationDenied.ResourceLockedTemporaryThis operation conflicts with concurrent operations. Try again later.
    ResourceInUse.CnameResources occupied by this account via CNAME.
    ResourceInUse.DnsDNS resources occupied.
    ResourceInUse.GenericHostResources occupied by the wildcard domain name.
    ResourceInUse.NSResources occupied by this account via NS.
    ResourceInUse.OthersThe resource has been connected to EdgeOne by another user.
    ResourceInUse.OthersAliasDomainResources occupied by the alias domain names under other accounts.
    ResourceInUse.OthersCnameResources occupied by other accounts via CNAME.
    ResourceInUse.OthersNSResources occupied by other accounts via NS.
    ResourceInUse.SelfAndOthersCnameResources occupied by this account and others via CNAME.
    ResourceNotFoundThe resource doesn’t exist.
    ResourceUnavailableThe resource is unavailable.
    UnauthorizedOperation.CamUnauthorizedCAM is not authorized.
    UnauthorizedOperation.NoPermissionThe sub-account is not authorized for the operation. Please get permissions first.