All Products
Search

This Product

    Edge Security Acceleration:ListOriginRules

    Document Center

    Edge Security Acceleration:ListOriginRules

    Last Updated:Jun 25, 2026

    Query multiple back-to-origin rule configurations.

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

    list

    *Site

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    SiteId

    integer

    Yes

    The site ID. You can obtain the site ID by calling the ListSites API operation.

    1234567890123
    ConfigId

    integer

    No

    The configuration ID.

    35281609698****
    ConfigType

    string

    No

    The configuration type. You can use this parameter to query global or rule configurations. Valid values:

    • global: Query global configurations.

    • rule: Query rule configurations.

    This parameter is optional. If not specified, both global and rule configurations are returned without distinction.

    Valid values:

    • rule :

      Rule configuration

    • global :

      Global configuration

    global
    RuleName

    string

    No

    The rule name. You do not need to set this parameter when adding a global configuration.

    test
    PageNumber

    integer

    No

    The page number for paginated queries. The value must be greater than or equal to 1. Default value: 1.

    1
    PageSize

    integer

    No

    The number of entries per page for paginated queries. Valid values: 1 to 500. Default value: 500.

    20
    SiteVersion

    integer

    No

    The version number of the site. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.

    1

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID.

    0AEDAF20-4DDF-4165-8750-47FF9C1929C9
    Configs

    array<object>

    The configurations in the response.

    object

    ConfigId

    integer

    The configuration ID.

    395386449776640
    SiteVersion

    integer

    The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.

    1
    Sequence

    integer

    The execution order of the rule. A smaller value indicates a higher priority.

    1
    RuleEnable

    string

    The rule switch. You do not need to set this parameter when adding a global configuration. Valid values:

    • on: Enable.

    • off: Disable.

    on
    Rule

    string

    The rule content, which uses conditional expressions to match user requests. You do not need to set this parameter when adding a global configuration. There are two usage scenarios:

    • Match all incoming requests: Set the value to true.

    • Match specified requests: Set the value to a custom expression, for example: (http.host eq "video.example.com")

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

    RuleName

    string

    The rule name. You do not need to set this parameter when adding a global configuration.

    rule_example
    ConfigType

    string

    The configuration type. You can query global or rule configurations based on this parameter. Valid values:

    • global: Query global configurations.

    • rule: Query rule configurations.

    global
    OriginHost

    string

    The HOST carried in the back-to-origin request.

    origin.example.com

    OriginScheme

    string

    The protocol used for back-to-origin requests. Valid values:

    • http: Use the HTTP protocol for back-to-origin.

    • https: Use the HTTPS protocol for back-to-origin.

    • follow: Follow the client protocol for back-to-origin.

    http
    OriginSni

    string

    The SNI carried in the back-to-origin request.

    origin.example.com
    DnsRecord

    string

    The rewritten DNS resolution record for back-to-origin requests.

    test.example.com

    OriginHttpPort

    string

    The origin server port accessed when using the HTTP protocol for back-to-origin.

    8080
    OriginHttpsPort

    string

    The origin server port accessed when using the HTTPS protocol for back-to-origin.

    4433
    Range

    string

    Use range-based slicing for back-to-origin file downloads. Valid values:

    • on: Enable.

    • off: Disable.

    • force: Force enable.

    on
    OriginMtls

    string

    The mTLS switch. Valid values:

    • on: Enable.

    • off: Disable.

    on
    OriginVerify

    string

    The origin server certificate verification switch. Valid values:

    • on: Enable.

    • off: Disable.

    on
    RangeChunkSize

    string

    The range chunk size.

    1MB
    OriginReadTimeout

    string

    The origin server read timeout period, in seconds.

    10
    Follow302Enable

    string

    The back-to-origin 302 redirect follow switch. Valid values:

    • on: Enable.

    • off: Disable.

    on
    Follow302MaxTries

    string

    The maximum number of 302 redirect follows. Valid values: 1 to 5.

    1
    Follow302RetainArgs

    string

    The switch for retaining original request parameters. Valid values:

    • on: Enable.

    • off: Disable.

    on
    Follow302RetainHeader

    string

    The switch for retaining original request headers. Valid values:

    • on: Enable.

    • off: Disable.

    on
    Follow302TargetHost

    string

    The back-to-origin host after 302 redirect modification.

    test.com
    PageNumber

    integer

    The current page number, same as the PageNumber request parameter.

    1
    PageSize

    integer

    The page size.

    10
    TotalCount

    integer

    The total number of records.

    100
    TotalPage

    integer

    The total number of pages.

    2

    Examples

    Success response

    JSON format

    {
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "Configs": [
    {
      "ConfigId": 395386449776640,
      "SiteVersion": 1,
      "Sequence": 1,
      "RuleEnable": "on",
      "Rule": "(http.host eq \\\"video.example.com\\\")\n",
      "RuleName": "rule_example",
      "ConfigType": "global",
      "OriginHost": "origin.example.com\n",
      "OriginScheme": "http",
      "OriginSni": "origin.example.com",
      "DnsRecord": "test.example.com\n",
      "OriginHttpPort": "8080",
      "OriginHttpsPort": "4433",
      "Range": "on",
      "OriginMtls": "on",
      "OriginVerify": "on",
      "RangeChunkSize": "1MB",
      "OriginReadTimeout": "10",
      "Follow302Enable": "on",
      "Follow302MaxTries": "1",
      "Follow302RetainArgs": "on",
      "Follow302RetainHeader": "on",
      "Follow302TargetHost": "test.com"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 100,
  "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.