tencent cloud

Feedback

ModifyZone

Last updated: 2022-09-01 15:05:24

1. API Description

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

This API is used to modify the site information.

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-01-06.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Id Yes String Site ID, which is used to identify the site.
Type No String Specifies how the site is connected to EdgeOne.
- full: Connect via the name server.
- partial: Connect via the CNAME.
VanityNameServers No VanityNameServers Custom site information

3. Output Parameters

Parameter Name Type Description
Id String Site ID
Name String Site name
OriginalNameServers Array of String Name server used by the site
Status String Site status.
- pending: The name server is not connected.
- active: The name server is connected.
- moved: The name server is moved.
Type String Specifies how the site is connected to EdgeOne.
- full: Connect via the name server.
- partial: Connect via the CNAME.
NameServers Array of String List of name servers assigned by Tencent Cloud
CreatedOn Timestamp ISO8601 Creation time
ModifiedOn Timestamp ISO8601 Modification time
CnameStatus String CNAME access status.
- finished: Ownership of the site is verified.
- pending: Verifying the ownership of the site.
Note: This field may return null, indicating that no valid value can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying 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": "xx",
        "Servers": [
            "xx"
        ]
    },
    "Type": "xx",
    "Id": "xx"
}

Output Example

{
    "Response": {
        "Status": "xx",
        "ModifiedOn": "2020-09-22T00:00:00+00:00",
        "Name": "xx",
        "NameServers": [
            "xx"
        ],
        "CreatedOn": "2020-09-22T00:00:00+00:00",
        "OriginalNameServers": [
            "xx"
        ],
        "RequestId": "xx",
        "Type": "xx",
        "Id": "xx",
        "CnameStatus": "xx"
    }
}

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
OperationDenied Operation denied.
ResourceNotFound The resource doesn’t exist.
ResourceUnavailable The resource is unavailable.
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