ListCustomResponseCodeRules - Edge Security Acceleration

Query the list of custom response code configurations for a 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:ListCustomResponseCodeRules

list

*Site

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

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	Site ID, which can be obtained by calling the ListSites API.	340035003106221
ConfigId	integer	No	Configuration ID.	436490043994112
ConfigType	string	No	Configuration type. You can use this parameter to query global or rule configurations. Valid values: global: queries global configurations. rule: queries rule configurations. Valid values: rule : Rule configuration global : Global configuration	global
RuleName	string	No	Rule name.	rule_example
SiteVersion	integer	No	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.	0
PageNumber	integer	No	Page number. Default value: 1.	1
PageSize	integer	No	Number of entries per page. Maximum value: 500. Default value: 500.	20

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	Request ID.	36af3fcc-43d0-441c-86b1-428951dc8225
Configs	array<object>	The list of custom response code configurations.
	object	The details of a custom response code configuration.
ConfigId	integer	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.	0
Sequence	integer	The execution order of the rule. A smaller value indicates a higher priority.	1
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. Two usage scenarios are supported: Match all incoming requests: set the value to true. Match specific requests: set the value to a custom expression, for example: (http.host eq "video.example.com").	(http.host eq "video.example.com")
RuleEnable	string	The rule switch. You do not need to set this parameter when adding a global configuration. Valid values: on: enables the rule. off: disables the rule.	on
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. Valid values: global: global configuration. rule: rule configuration.	global
ReturnCode	string	The response code.	200
PageId	string	The response page.	0
PageNumber	integer	Page number. Default value: 1.	1
PageSize	integer	Page size. Default value: 500. Valid values: 1 to 500.	20
TotalCount	integer	Total number of entries.	10
TotalPage	integer	Total number of pages.	1

Examples

Success response

JSON format

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "Configs": [
    {
      "ConfigId": 395386449776640,
      "SiteVersion": 0,
      "Sequence": 1,
      "Rule": "(http.host eq \"video.example.com\")",
      "RuleEnable": "on",
      "RuleName": "rule_example",
      "ConfigType": "global",
      "ReturnCode": "200",
      "PageId": "0"
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 10,
  "TotalPage": 1
}

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.