ListHttpIncomingRequestHeaderModificationRules - Edge Security Acceleration

Queries the configuration details of an incoming HTTP request header modification rule for a website.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
esa:ListHttpIncomingRequestHeaderModificationRules	none	*Site `acs:esa:{#regionId}:{#accountId}:site/{#SiteId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
SiteId	long	Yes	The website ID, which can be obtained by calling the ListSites operation.	608665779308176
ConfigId	long	No	The configuration ID. You can call the ListHttpIncomingRequestHeaderModificationRules operation to query the ID.	424371770570752
ConfigType	string	No	The configuration type to query. Valid values: global: global configurations. rule: rule configurations.	rule
RuleName	string	No	The rule name.	rule_example
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Maximum value: 500. Default value: 500.	20
SiteVersion	integer	No	The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.	0

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	7FB6EBC8-8849-5FC6-890E-3A761A5CD42D
Configs	array<object>	The configuration list of the incoming HTTP request header modification.
configs	object	The configurations of the incoming HTTP request header modification.
ConfigId	long	The configuration ID.	429422870243328
SiteVersion	integer	The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.	0
Sequence	integer	The order in which the rule is executed. A smaller value gives priority to the rule.	1
Rule	string	The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases: true: Match all incoming requests. Set the value to a custom expression, for example, (http.host eq "video.example.com"): Match the specified request.	(http.host eq "video.example.com")
RuleEnable	string	Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Valid values: on off	on
RuleName	string	The rule name. You do not need to set this parameter when you add global configuration.	rule_example
ConfigType	string	The type of the configuration. Valid values: global: global configurations. rule: rule configurations.	rule
RequestHeaderModification	array<object>	The configurations of modifying request headers. You can add, delete, or modify a request header.
itemRequestHeader	object	The configuration of modifying a request header.
Name	string	The name of the request header.	headerName
Operation	string	The action. Valid values: add: adds a response header. del: deletes a response header. modify: modifies a response header.	add
Value	string	The value of the request header.	headerValue
Type	string	The type of the value. Valid values: static dynamic	static
PageNumber	integer	The number of the returned page. Default value: 1.	1
PageSize	integer	The number of entries per page. Default value: 500. Valid values: 1 to 500.	20
TotalCount	integer	The total number of entries.	10
TotalPage	integer	The number of entries per page.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "7FB6EBC8-8849-5FC6-890E-3A761A5CD42D",
  "Configs": [
    {
      "ConfigId": 429422870243328,
      "SiteVersion": 0,
      "Sequence": 1,
      "Rule": "(http.host eq \"video.example.com\")",
      "RuleEnable": "on",
      "RuleName": "rule_example",
      "ConfigType": "rule",
      "RequestHeaderModification": [
        {
          "Name": "headerName",
          "Operation": "add",
          "Value": "headerValue",
          "Type": "static"
        }
      ]
    }
  ],
  "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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-12-11	The Error code has changed	View Change Details