RecoverSite - Edge Security Acceleration - Alibaba Cloud Documentation Center

Restores the status of a site that has been deactivated.

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:RecoverSite

none

*Site

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

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The site ID. You can call the ListSites operation to obtain the site ID.	123456****

Response elements

Element	Type	Description	Example
	object	The response parameters.
AccessType	string	The access type. Valid values: NS: access through NS hosting. CNAME: access through CNAME.	NS
CnameZone	string	The CNAME suffix of the site. For sites that are accessed through CNAME, this field indicates the CNAME suffix that needs to be configured for records.	gf-test.hkrt.cn
Coverage	string	The acceleration region of the site. Valid values: domestic: the Chinese mainland only. global: global. overseas: global (excluding the Chinese mainland).	global
CreateTime	string	The creation time.	2024-03-11T01:23:21Z
InstanceId	string	The plan instance ID.	esa-site-9vjienwn****
NameServerList	string	The list of name servers assigned to the site, separated by commas (,). When the site uses NS access, this field contains values. You need to change the DNS servers of the site to these name servers. Then you can verify the site ownership and activate the site.	ns1.example.com,ns2.example.com
OfflineReason	string	The reason why the site was deactivated. Valid values: expiration_arrears: The subscription plan expired or the account has an overdue payment. internally_disabled: The site was disabled by the system. missing_icp: The domain name does not have an ICP filing. content_violation: Content violation. proactively_disabled: You proactively disabled the site or the site was disabled because the usage cap you configured was reached.	expiration_ arrears
PlanName	string	The plan name.	basic
RequestId	string	The request ID.	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
ResourceGroupId	string	The resource group ID.	rg-axxxxxx
SiteId	integer	The site ID.	123456****
SiteName	string	The site name.	example.com
Status	string	The site status. Valid values: pending: The site is pending configuration. active: The site is activated. offline: The site is offline. moved: The site has been replaced.	active
UpdateTime	string	The modification time.	2025-03-13T02:13:28Z
VerifyCode	string	The site ownership verification code. When the site is accessed through CNAME, this is the TXT verification code that needs to be configured.	verify_d516cb3740f81f0cef77d162edd1****

Examples

Success response

JSON format

{
  "AccessType": "NS",
  "CnameZone": "gf-test.hkrt.cn",
  "Coverage": "global",
  "CreateTime": "2024-03-11T01:23:21Z\n",
  "InstanceId": "esa-site-9vjienwn****",
  "NameServerList": "ns1.example.com,ns2.example.com",
  "OfflineReason": "expiration_ arrears",
  "PlanName": "basic",
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "ResourceGroupId": "rg-axxxxxx",
  "SiteId": 0,
  "SiteName": "example.com ",
  "Status": "active",
  "UpdateTime": "2025-03-13T02:13:28Z",
  "VerifyCode": "verify_d516cb3740f81f0cef77d162edd1****\n"
}

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.
400	Site.InBlacklist	The site name is in the blacklist.	The site name is in the blacklist.
400	ICPCheckFailed	The ICP filing verification service is temporarily unavailable. Please try again later.	The filing query service is abnormal. Please try again later.
400	InvalidSiteICP	The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.	The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.