Retrieve HTTP Header Modification Rules with ESA API - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Queries the list of HTTP incoming request header modification 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:ListHttpIncomingRequestHeaderModificationRules

none

*Site

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

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.	608665779308176
ConfigId	integer	No	The configuration ID. You can call the ListHttpIncomingRequestHeaderModificationRules operation to obtain the configuration ID.	424371770570752
ConfigType	string	No	The 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.	rule
RuleName	string	No	The rule name.	rule_example
PageNumber	integer	No	The page number for a paged query. The value must be greater than or equal to 1.	1
PageSize	integer	No	The number of entries per page for a paged query. Valid values: 1 to 500.	20
SiteVersion	integer	No	The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. The default value is version 0.	0

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	7FB6EBC8-8849-5FC6-890E-3A761A5CD42D
Configs	array<object>	The list of HTTP incoming request header modification configurations.
	array<object>	The details of an HTTP incoming request header modification configuration.
ConfigId	integer	The configuration ID.	429422870243328
SiteVersion	integer	The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. The default value is version 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 a conditional expression to match user requests. This parameter does not need to be set when adding a global configuration. Two usage scenarios exist: Match all incoming requests: Set the value to true. Match specified 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. This parameter does not need to be set when adding a global configuration. Valid values: on: enabled. off: disabled.	on
RuleName	string	The rule name. This parameter does not need to be set when adding a global configuration.	rule_example
ConfigType	string	The configuration type. Valid values: global: global configuration. rule: rule configuration.	rule
RequestHeaderModification	array<object>	The request header modifications, which support add, delete, and modify operations.
	object	The details of a request header modification.
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 current page number, which is the same as the PageNumber request parameter.	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 total number of pages.	1

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.