All Products
Search
Document Center

Edge Security Acceleration:CheckSiteName

Last Updated:Nov 15, 2025

Checks whether a specified website name is available.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
esa:CheckSiteNamenone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SiteNamestringYes

The website name.

example.com

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

CB1A380B-09F0-41BB-280B-72F8FD6DA2FE
Passedboolean

Indicates whether the verification passed.

  • true
  • false
true
Messeagestring

The verification message.

Descriptionstring

The description of the verification result. Valid values:

  • success: The verification is successful.
  • Site.AlreadyExist: The website domain name has already been added.
  • Site.InvalidName: Invalid website domain name.
  • Site.SubSiteUnavailable: Subdomains are not allowed.
  • Site.InternalError: An internal error occurs.
success
IsSubSiteboolean

Indicates whether a subdomain is specified. Valid values:

  • true
  • false
false

Examples

Sample success responses

JSONformat

{
  "RequestId": "CB1A380B-09F0-41BB-280B-72F8FD6DA2FE",
  "Passed": true,
  "Messeage": "",
  "Description": "success",
  "IsSubSite": false
}

Error codes

HTTP status codeError codeError messageDescription
400InternalExceptionFailed to call the service. Try again later or contact technical support.Failed to call the service. Try again later or contact technical support.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-09-18The Error code has changedView Change Details