tencent cloud

Feedback

CreateZone

Last updated: 2023-03-09 17:41:40

1. API Description

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

This API is used to access a new 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: CreateZone.
Version Yes String Common Params. The value used for this API: 2022-01-06.
Region No String Common Params. This parameter is not required for this API.
Name Yes String Site name
Type No String Access mode. Valid values:
- full (default): Access via NS
- partial: Access via CNAME
JumpStart No Boolean Specifies whether to skip resolution record scanning
Tags.N No Array of Tag Resource tag

3. Output Parameters

Parameter Name Type Description
Id String Site ID
Name String Site name
Type String Specifies how the site is connected to EdgeOne.
Status String Site status
- pending: The name server is not switched.
- active: The name server is switched to another assigned.
- moved: Move the NS out of Tencent Cloud
OriginalNameServers Array of String List of name servers
NameServers Array of String List of name servers assigned to users
CreatedOn Timestamp ISO8601 Site creation date
ModifiedOn Timestamp ISO8601 Site update time
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a site

Input Example

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

{
    "JumpStart": true,
    "Type": "xx",
    "Name": "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"
    }
}

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.
LimitExceeded The quota limit has been reached.
OperationDenied Operation denied.
ResourceInUse The resource is occupied.
ResourceInUse.Others The resource has been connected to EdgeOne by another user.
UnauthorizedOperation.CamUnauthorized CAM is not authorized.
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