ListSiteRoutes - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries the edge function routes for a website.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
esa:ListSiteRoutes	none	*Site `acs:esa:{#regionId}:{#accountId}:site/{#SiteId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
SiteId	long	Yes	The website ID, which can be obtained by calling the ListSites operation.	123456****
ConfigId	long	No	The configuration ID.	35281609698****
ConfigType	string	No	The configuration type. You can use this parameter to query global configurations or feature configurations. This parameter takes effect only if the functionName parameter is passed. Valid values: global rule	global
RouteName	string	No	The rule name. This parameter takes effect only when parameter functionName is specified.	test_route
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Maximum value: 500. Default value: 500.	20

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
Configs	array<object>	The returned configurations.
configs	object
ConfigId	long	The configuration ID.	35281609698****
SiteVersion	integer	The version number of the website.	1
Sequence	integer	The order in which the rule is executed.	1
RouteEnable	string	The route switch. Valid values: on off	on
Rule	string	The rule content.	(http.host eq \"video.example.com\")
RouteName	string	The route name.	test_route
ConfigType	string	The configuration type to query. Valid values: global: global configurations. rule: queries rule configurations.	global
RoutineName	string	The function name.	test-routine1
Bypass	string	The bypass mode. Valid values: on off	on
Mode	string	The configuration mode. Specifies whether to check the image used by the instance supports hot migration. Valid values: simple: Simple Mode custom: Custom Mode	simple
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries returned.	16
TotalPage	integer	The total number of pages returned.	10

Examples

Sample success responses

JSONformat

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368\n",
  "Configs": [
    {
      "ConfigId": 0,
      "SiteVersion": 1,
      "Sequence": 1,
      "RouteEnable": "on",
      "Rule": "(http.host eq \\\"video.example.com\\\")",
      "RouteName": "test_route",
      "ConfigType": "global",
      "RoutineName": "test-routine1",
      "Bypass": "on",
      "Mode": "simple",
      "Fallback": ""
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 16,
  "TotalPage": 10
}

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.FunctionName	The specified feature does not exist. Specify a valid feature name based on the related documentation.	The specified feature does not exist. Specify a valid feature name based on the related documentation.

For a list of error codes, visit the Service error codes.