Verify SaaS Custom Domain Ownership via VerifyCustomHostname API - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Verifies the ownership of a SaaS domain name. Sites that pass the verification are automatically activated.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
HostnameId	integer	Yes	The ID of the SaaS domain name. You can call the ListCustomHostnames operation to obtain the ID.	1234567890123

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID. A unique identifier that Alibaba Cloud generates for the request.	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
Passed	boolean	Indicates whether the verification is passed.	true

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
200	CustomHostname.VerifyUnpassed	The custom hostname ownership verification failed. Complete the verification and try again.	The custom hostname ownership verification failed. Complete the verification and try again.
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	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	NoPermission	You do not have permissions to access or operate on the resource.Contact your account administrator to attach the AliyunESAFullAccess policy to the current user.	You do not have permissions to access or operate on the resource.Contact your account administrator to attach the AliyunESAFullAccess policy to the current user.
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	Record.ServiceBusy	The record is being configured. Try again later.	The record is being configured. Try again later.
400	CustomHostname.InvalidICP	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.
400	CustomHostname.ConflictWithExistingResource	The custom hostname conflicts with existing resources, such as sites, records, load balancers, source address pools, custom hostnames and Layer 4 proxy records.	The custom hostname conflicts with existing resources, such as sites, records, load balancers, source address pools, custom hostnames and Layer 4 proxy records.
400	CustomHostname.OfflineForMultiReason	Unable to activate the custom hostname because it is offline due to multiple reasons.
400	CustomHostname.InvalidStatus	The status of the custom hostname you configured is invalid, and this operation cannot be performed. Please check the status of the custom hostname and try again.	The status of the custom hostname you configured is invalid, and this operation cannot be performed. Please check the status of the custom hostname and try again.
404	CustomHostname.NotFound	The custom hostname does not exist. Modify it and try again.	The custom hostname does not exist. Modify it and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.