ListCustomResponseCodeRules - Edge Security Acceleration

List the custom response code configurations for the 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

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	The site ID. For more information, see ListSites.	340035003106221
ConfigId	integer	No	The configuration ID.	436490043994112
ConfigType	string	No	The configuration type. Use this parameter to query global or rule configurations. Valid values: global: Queries global configurations. rule: Queries rule configurations.	global
RuleName	string	No	The rule name.	rule_example
SiteVersion	integer	No	The version number of the site configuration. For sites with configuration version control enabled, specify the site version for which the configuration takes effect using this parameter. The default value is version 0.	0
PageNumber	integer	No	The page number. The default value is 1 if you do not specify this parameter.	1
PageSize	integer	No	The number of entries per page. The maximum value is 500. The default value is 500 if you do not specify this parameter.	20

Response elements

Element	Type	Description	Example
	object	The request response.
RequestId	string	The request ID.	36af3fcc-43d0-441c-86b1-428951dc8225
Configs	array<object>	You can modify the response code configuration list.
	object	The details of the custom response code configuration.
ConfigId	integer	The configuration ID.	395386449776640
SiteVersion	integer	The version number of the site configuration. For sites with configuration version control enabled, this parameter specifies the site version for which the configuration takes effect. The default value is version 0.	0
Sequence	integer	The rule execution order. A smaller value indicates higher priority.	1
Rule	string	The rule content. Use a conditional expression 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")
RuleEnable	string	The rule switch. Do not set this parameter when adding a global configuration. Valid values: on: Enabled. off: Disabled.	on
RuleName	string	The rule name. Do not 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	The page number. Default value: 1.	1
PageSize	integer	The page size. Default value: 500. Valid values: 1 to 500.	20
TotalCount	integer	The total number of entries.	10
TotalPage	integer	The 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.