All Products
Search

This Product

    Edge Security Acceleration:GetRedirectRule

    Document Center

    Edge Security Acceleration:GetRedirectRule

    Last Updated:Jun 25, 2026

    Queries the details of a redirect rule for a specified 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:GetRedirectRule

    get

    *Site

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    SiteId

    integer

    Yes

    The site ID. You can call the ListSites operation to obtain the site ID.

    34003500310****
    ConfigId

    integer

    Yes

    The configuration ID. You can call the ListRedirectRules operation to obtain the configuration ID.

    35281609698****

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

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

    integer

    The configuration ID.

    35281609698****
    ConfigType

    string

    The configuration type. Valid values:

    • global: Global configuration.

    • rule: Rule-based configuration.

    rule
    SiteVersion

    integer

    The version number of the site configuration. For sites with version management enabled, this parameter specifies the effective version. Default value: 0.

    0
    Sequence

    integer

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

    1
    RuleEnable

    string

    Specifies whether the rule is enabled. Not required for global configurations. Valid values:

    • on: Enabled.

    • off: Disabled.

    on
    Rule

    string

    The rule content, which uses conditional expressions to match user requests. Not required for global configurations. Usage scenarios:

    • Match all incoming requests: Set the value to true

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

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

    string

    The rule name. Not required for global configurations.

    rule_example
    Type

    string

    The redirect type. Valid values:

    • static: Static mode.

    • dynamic: Dynamic mode.

    static
    TargetUrl

    string

    The target URL to redirect to.

    http://www.exapmle.com/index.html
    StatusCode

    string

    The HTTP status code returned to the client for the redirect. Valid values:

    • 301

    • 302

    • 303

    • 307

    • 308

    301
    ReserveQueryString

    string

    Specifies whether to preserve the query string. Valid values:

    • on: Enabled.

    • off: Disabled.

    on

    Examples

    Success response

    JSON format

    {
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "ConfigId": 0,
  "ConfigType": "rule",
  "SiteVersion": 0,
  "Sequence": 1,
  "RuleEnable": "on",
  "Rule": "(http.host eq \"video.example.com\")",
  "RuleName": "rule_example",
  "Type": "static",
  "TargetUrl": "http://www.exapmle.com/index.html",
  "StatusCode": "301",
  "ReserveQueryString": "on"
}

    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.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.