Verify Domain Ownership via VerifySite API to Activate Your Site - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Operation description

For a website connected by using NS setup, this operation verifies whether the nameservers of the website are the nameservers assigned by Alibaba Cloud.
For a website connected by using CNAME setup, this operation verifies whether the website has a TXT record whose hostname is _esaauth.[websiteDomainName] and record value is the value of VerifyCode to the DNS records of your domain. You can see the VerifyCode field in the site information.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

esa:VerifySite

none

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The website ID, which can be obtained by calling the ListSites operation.	1234567890123

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	65C66B7B-671A-8297-9187-2R5477247B76
Passed	boolean	Indicates whether the verification passed. Valid values: true false	true

Examples

Success response

JSON format

{
  "RequestId": "65C66B7B-671A-8297-9187-2R5477247B76",
  "Passed": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.
400	Site.ServiceBusy	This website is being configured. Try again later.	This website is being configured. Try again later.
400	Site.Conflict	Duplicate website names exist across multiple accounts. Rename or delete one and try again.	Duplicate website names exist across multiple accounts. Rename or delete one and try again.
400	InvalidParameter	Invalid parameter. Check the parameter configuration.	Invalid parameter. Check the parameter configuration.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.