Get HTTP Request Header Modification Rules via API - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

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

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:GetHttpIncomingRequestHeaderModificationRule

get

*Site

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

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The website ID, which can be obtained by calling the ListSites operation.	608665779308176
ConfigId	integer	Yes	The configuration ID. You can call the ListHttpIncomingRequestHeaderModificationRules operation to obtain the ID.	433045006266368

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	5CC228B4-7A67-4016-9C9F-4A4133494A91
ConfigId	integer	The ID of the configuration.	402411533580288
ConfigType	string	The type of the configuration. Valid values: global: the global configuration. rule: the rule configuration.	global
SiteVersion	integer	The version number of the website configuration. Specifies which version of the website to apply the feature settings to. Default value: 0.	0
Sequence	integer	The execution order of the rule. A smaller value indicates higher priority.	1
RuleEnable	string	Indicates whether the rule is enabled. This parameter is not required for global configurations. Valid values: on off	on
Rule	string	The rule content, which is a conditional expression used to match incoming requests. This parameter is not required for global configurations. Examples: true: Match all incoming requests. Set the value to a custom expression, for example, (http.host eq "video.example.com"), to match specific requests.	(http.host eq "video.example.com")
RuleName	string	The rule name. This parameter is not required for global configurations.	rule_example
RequestHeaderModification	array<object>	The request header modification settings. You can add, delete, or modify request headers.
	object	The details of a single 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.	headValue
Type	string	The value type. Valid values: static dynamic	static

Examples

Success response

JSON format

{
  "RequestId": "5CC228B4-7A67-4016-9C9F-4A4133494A91",
  "ConfigId": 402411533580288,
  "ConfigType": "global",
  "SiteVersion": 0,
  "Sequence": 1,
  "RuleEnable": "on",
  "Rule": "(http.host eq \"video.example.com\")",
  "RuleName": "rule_example\n",
  "RequestHeaderModification": [
    {
      "Name": "headerName",
      "Operation": "add",
      "Value": "headValue",
      "Type": "static"
    }
  ]
}

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.