Retrieve HTTP Response Header Rules via GetHttpResponseHeaderModificationRule - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Queries the details of a specific HTTP response header modification rule 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:GetHttpResponseHeaderModificationRule

get

*Site

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

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The site ID. You can obtain the site ID by calling the ListSites operation.	123456****
ConfigId	integer	Yes	The configuration ID. You can obtain the configuration ID by calling the ListHttpResponseHeaderModificationRules operation.	35281609698****

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395
ConfigId	integer	The configuration ID.	35281609698****
ConfigType	string	The configuration type. Valid values: `global`: global configuration. `rule`: rule configuration.	rule
SiteVersion	integer	The version of the site configuration. When configuration versioning is enabled for the site, this parameter indicates the version that the configuration applies to. Default value: 0.	0
Sequence	integer	The rule execution order. A smaller value indicates a higher priority.	1
RuleEnable	string	Indicates whether the rule is enabled. This parameter applies only to rule configurations. Valid values: `on`: The rule is enabled. `off`: The rule is disabled.	on
Rule	string	The rule content, which is a conditional expression that matches incoming requests. This parameter applies only to rule configurations. Valid values: `true`: matches all incoming requests. A custom expression, such as `(http.host eq "video.example.com")`: matches specific requests.	(http.host eq "video.example.com")
RuleName	string	The rule name. This parameter applies only to rule configurations.	rule_example
ResponseHeaderModification	array<object>	The list of response header modifications.
	object	The details of a response header modification entry.
Name	string	The response header name.	headerName
Operation	string	The operation. Valid values: `add`: Adds a header. `del`: Deletes a header. `modify`: Modifies a header.	add
Value	string	The response header value.	headerValue
Type	string	The value type. Valid values: `static`: static mode. `dynamic`: dynamic mode.	static

Examples

Success response

JSON format

{
  "RequestId": "EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395",
  "ConfigId": 0,
  "ConfigType": "rule",
  "SiteVersion": 0,
  "Sequence": 1,
  "RuleEnable": "on",
  "Rule": "(http.host eq \"video.example.com\")",
  "RuleName": "rule_example",
  "ResponseHeaderModification": [
    {
      "Name": "headerName",
      "Operation": "add",
      "Value": "headerValue",
      "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.