ListSiteRoutes API Reference for Edge Function Routes - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Queries the list of Edge Routine routes for a 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

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

none

*Site

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

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The site ID, which can be obtained by calling the ListSites operation.	123456****
ConfigId	integer	No	The configuration ID.	35281609698****
ConfigType	string	No	The configuration type. You can use this parameter to query global or feature configurations. This parameter takes effect only when functionName is specified. Valid values: rule : rule configuration. global : global configuration.	global
RouteName	string	No	The route name. You can use this parameter to query the rule whose name matches the specified value. This parameter takes effect only when functionName is specified.	test_route
PageNumber	integer	No	The page number for a paged query. The value must be greater than or equal to 1.	1
PageSize	integer	No	The number of entries per page for a paged query. Valid values: 1 to 500.	20

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
Configs	array<object>	The configuration list in the response.
	object
ConfigId	integer	The configuration ID.	35281609698****
SiteVersion	integer	The version number of the site.	1
Sequence	integer	The execution order of the rule.	1
RouteEnable	string	The route switch. Valid values: on: Enabled. off: Disabled.	on
Rule	string	The rule content.	(http.host eq \"video.example.com\")
RouteName	string	The route name.	test_route
ConfigType	string	The configuration type. You can use this parameter to query global or rule configurations. Valid values: global: Queries global configurations. rule: Queries rule configurations.	global
RoutineName	string	The Edge Routine name.	test-routine1
Bypass	string	The bypass mode. Valid values: on: Enabled. off: Disabled.	on
Mode	string	The configuration mode. Valid values: simple: Simple mode. custom: Custom mode.	simple
Fallback	string	The CDN fallback. Valid values: on: Enabled. off: Disabled.	on
Timeout	string	The Edge Routine timeout period, in seconds.	60
PageNumber	integer	The current page number, which is the same as the PageNumber request parameter.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of records.	16
TotalPage	integer	The total number of pages.	10

Examples

Success response

JSON format

{
  "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": "on",
      "Timeout": "60"
    }
  ],
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.