List Edge Function Routes with Pagination via ListRoutineRoutes - Edge Security Acceleration - Alibaba Cloud -

Queries the function route list of an Edge Routine.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
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.	10
RoutineName	string	Yes	The name of the Edge Routine.	test-routine1

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 information.
	object
SiteId	integer	The site ID.	554889455535696
SiteName	string	The site name.	test.com
ConfigId	integer	The configuration ID.	35281609698****
SiteVersion	integer	The version number of the site configuration.	1
Sequence	integer	The rule execution order.	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 configurations or rule configurations. Valid values: global: queries global configurations. rule: queries rule configurations.	global
RoutineName	string	The name of the Edge Routine.	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 fallback-to-origin switch. After this switch is enabled, requests are sent to the origin server if the function encounters an exception such as CPU usage exceeding the limit. Valid values: on: enabled. off: disabled.	on
Timeout	string	The ER timeout period. Valid values: 5 to 60. Unit: seconds.	5
PageNumber	integer	The current page number, which is the same as the PageNumber request parameter.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of records.	83
TotalPage	integer	The total number of pages.	2

Examples

Success response

JSON format

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

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.