Configure Custom Nameservers via UpdateSiteVanityNS API - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Modifies the custom nameserver (NS) names for a single site.

Operation description

The site plan must be Enterprise Edition or higher to use the custom NS feature.

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

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 query the site ID.	1234567890123
VanityNSList	string	No	The list of custom NS names. You can specify 2 to 5 custom NS names, separated by commas (,).	ns1.example.com,ns2.example.com

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	0AEDAF20-4DDF-4165-8750-47FF9C1929C9

Examples

Success response

JSON format

{
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	ApplyVanityNSError	Failed to apply for vanity NS resources. Please contact customer service.	Failed to apply for vanity NS resources. Please contact customer service.
400	OperationDenied.VanityNSUnavailable	Only sites in NS access type can use vanity nameservers. Convert your site to NS access type and try again.	Sites that are accessed only by NS mode can use custom NS. Please adjust your site access mode and try again.
400	InvalidParameter.InvalidVanityNSNum	Enter 2 to 5 vanity nameservers. Correct them and try again.	Custom NS requires 2~5 names, please adjust and resubmit.
400	InvalidParameter.InvalidVanityNSName	A vanity nameserver must be an absolute domain name. Correct it and try again.	You need to enter the full domain name to customize the NS name. Please adjust and submit it again.
400	InvalidParameter.VanityNSNameDuplicate	The vanity nameservers are duplicated. Please delete it and try again.	Duplicate custom NS name exists, please delete and resubmit.
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	Instance.NotOnline	Your plan is unavailable due to an overdue payment. Complete the payment first.	Your plan is unavailable due to an overdue payment. Complete the payment first.
400	QuotaCheckFailed.CustomNS	Custom nameservers are not allowed in your plan. Check the plan description and upgrade the plan.	Custom nameservers are not allowed in your plan. Check the plan description and upgrade the plan.
400	Site.ServiceBusy	This website is being configured. Try again later.	This website is being configured. Try again later.
400	Record.Conflict	The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.	The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.
400	InvalidParameter.RecordsExceedLimit	The number of incoming records exceeds the maximum limit.	The number of incoming records exceeds the maximum limit.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.