All Products
Search
Document Center

:Check a zone name

Last Updated:Dec 26, 2025

Checks whether a zone can be added based on the specified rules.

Debug

You can call this operation directly in OpenAPI Explorer. This saves you the effort of calculating a signature. After a successful call, OpenAPI Explorer automatically generates sample code for different software development kits (SDKs).

Request parameters

Name Type Required Example value Description
Action String Yes CheckZoneName

A required parameter. Set the value to CheckZoneName.

Lang String No en

Language.

ZoneName String Yes example.com

The name of the zone. This parameter is required.

UserClientIp String No 192.0.2.0

The IP address of the client.

Return Data

Name Type Example value Description
RequestId String CA29B88F-A571-4123-80D5-768AC2F7F806

The request ID.

Check Boolean true

Indicates whether the zone can be added. Valid values:

  • true: The zone can be added.
  • false: The zone cannot be added.
Success Boolean true

Indicates whether the operation was successful.

Examples

Sample request

http(s)://pvtz.aliyuncs.com/?Action=CheckZoneName
&Lang=en
&ZoneName=example.com
&UserClientIp=192.0.2.0
&<Common request parameters>

Sample responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CheckZoneNameResponse>
    <RequestId>CA29B88F-A571-4123-80D5-768AC2F7F806</RequestId>
    <Check>true</Check>
    <Success>true</Success>
</CheckZoneNameResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "CA29B88F-A571-4123-80D5-768AC2F7F806",
  "Check" : true,
  "Success" : true
}

Error codes

For a list of error codes, see the Error Center.