Edge Security Acceleration:GetMatchSite

Retrieves the information of the longest-matching active site for a given record name under the current user. For example, if the input record name is www.test.example.com and the user has two active sites (test.example.com and example.com), the API returns the longest-matching active site test.example.com. If no matching active site is found, an error is returned.

Operation description

Used with the Edge Routine (ER) feature to automatically match an active site.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RecordName	string	Yes	The record name.	www.example.com

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE
SiteId	integer	The site ID.	1234567890****
SiteName	string	The site name.	example.com

Examples

Success response

JSON format

{
  "RequestId": "CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE",
  "SiteId": 0,
  "SiteName": "example.com"
}

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	InvalidParameter.InvalidRecordName	The record name you entered does not meet the specifications. Change the record name according to the product documentation.	The record name you entered does not meet the specifications. Please adjust the record name according to the product documentation.
400	ActiveSiteNotExist	Failed to match an active website based on the hostname you specified. Check whether the hostname is correct or activate the website first.	Failed to match an active website based on the hostname you specified. Check whether the hostname is correct or activate the website first.
403	Record.AlreadyExist	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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.