All Products
Search
Document Center

Edge Security Acceleration:ListRoutineRoutes

Last Updated:Nov 07, 2025

Queries the routes of an edge function.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
esa:ListRoutineRoutesnone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Maximum value: 500. Default value: 500.

10
RoutineNamestringYes

The function name.

test-routine1

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

04F0F334-1335-436C-A1D7-6C044FE73368
Configsarray<object>

The returned configurations.

configsobject
SiteIdstring

The website ID.

554889455535696
SiteNamestring

The website name.

test.com
ConfigIdlong

The configuration ID.

35281609698****
SiteVersioninteger

The version number of the website configurations.

1
Sequenceinteger

The order in which the rule is executed.

1
RouteEnablestring

The route switch. Valid values:

  • on
  • off
on
Rulestring

The rule content.

(http.host eq \"video.example.com\")
RouteNamestring

The route name.

test_route
ConfigTypestring

The configuration type to query. Valid values:

  • global: global configurations.
  • rule: queries rule configurations.
global
RoutineNamestring

The routine name.

test-routine1
Bypassstring

Bypass mode. Valid values:

  • on
  • off
on
Modestring

The configuration mode. Valid values:

  • simple: Simple mode.
  • custom: Custom mode.
simple
Fallbackstring

The exception origin switch. After you turn on this switch, if a function exception occurs, such as CPU usage exceeding the upper limit, requests are sent back to the origin. Valid values:

  • on
  • off
on
PageNumberinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries per page.

20
TotalCountinteger

The total number of entries returned.

83
TotalPageinteger

The number of entries per page.

2

Examples

Sample success responses

JSONformat

{
  "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"
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 83,
  "TotalPage": 2
}

Error codes

HTTP status codeError codeError messageDescription
400InternalExceptionFailed to call the service. Try again later or contact technical support.Failed to call the service. Try again later or contact technical support.
400InvalidParameter.FunctionNameThe 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.