All Products
Search

This Product

    Edge Security Acceleration:GetCustomResponseCodeRule

    Document Center

    Edge Security Acceleration:GetCustomResponseCodeRule

    Last Updated:Feb 11, 2026

    Retrieve details about a site's custom response code configuration.

    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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    SiteId

    integer

    Yes

    Site ID. For more information, see ListSites.

    775724064754208
    ConfigId

    integer

    Yes

    Configuration ID.

    424022244554752

    Response elements

    Element

    Type

    Description

    Example

    object

    The request response result.

    RequestId

    string

    Request ID.

    36af3fcc-43d0-441c-86b1-428951dc8225
    ConfigId

    integer

    Configuration ID.

    352816096987136
    ConfigType

    string

    The configuration type. Valid values:

    • global: Global configuration.

    • rule: Rule configuration.

    global
    SiteVersion

    integer

    The version number of the site configuration. For sites with version control enabled, use this parameter to specify the site version where the configuration takes effect. The default is version 0.

    0
    Sequence

    integer

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

    1
    RuleEnable

    string

    The rule switch. Do not set this parameter when adding a global configuration. Valid values:

    • on: Enable.

    • off: Disable.

    on
    Rule

    string

    The rule content. Use conditional expressions to match user requests. Do not set this parameter when adding a global configuration. There are two scenarios:

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

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

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

    RuleName

    string

    The rule name. Do not set this parameter when adding a global configuration.

    rule_example
    ReturnCode

    string

    The response code.

    200
    PageId

    string

    The response page.

    0

    Examples

    Success response

    JSON format

    {
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "ConfigId": 352816096987136,
  "ConfigType": "global",
  "SiteVersion": 0,
  "Sequence": 1,
  "RuleEnable": "on",
  "Rule": "(http.host eq \"video.example.com\")\n",
  "RuleName": "rule_example",
  "ReturnCode": "200",
  "PageId": "0"
}

    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.