All Products
Search
Document Center

Edge Security Acceleration:GetHttpIncomingResponseHeaderModificationRule

Last Updated:Jan 14, 2026

Queries the configuration details of an incoming HTTP response 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
esa:GetHttpIncomingResponseHeaderModificationRuleget
*Site
acs:esa:{#regionId}:{#accountId}:site/{#SiteId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SiteIdlongYes

The website ID, which can be obtained by calling the ListSites operation.

347168101647504
ConfigIdlongYes

The configuration ID. You can call the ListHttpIncomingResponseHeaderModificationRules operation to query the ID.

430509230649344

Response parameters

ParameterTypeDescriptionExample
object

The response.

RequestIdstring

The request ID.

EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395
ConfigIdlong

The configuration ID.

432637955352576
ConfigTypestring

The configuration type. Valid values:

  • global: global configurations.
  • rule: rule configurations.
rule
SiteVersioninteger

The version number of the 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
Sequenceinteger

The order in which the rule is executed. A smaller value gives priority to the rule.

1
RuleEnablestring

Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Specifies whether to check the image used by the instance supports hot migration. Valid values:

  • on
  • off
on
Rulestring

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")
RuleNamestring

The rule name. You do not need to set this parameter when you add global configuration.

rule_example
ResponseHeaderModificationarray<object>

The configurations of modifying response headers. You can add, delete, or modify a response header.

ItemResponseHeaderobject

The configuration of modifying a response header.

Namestring

The name of the response header.

headerName
Operationstring

The action. Valid values:

  • add: adds a response header.
  • del: deletes a response header.
  • modify: modifies a response header.
add
Valuestring

The value of the response header.

headerValue
Typestring

The value type. Valid values:

  • static
  • dynamic
static

Examples

Sample success responses

JSONformat

{
  "RequestId": "EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395",
  "ConfigId": 432637955352576,
  "ConfigType": "rule",
  "SiteVersion": 0,
  "Sequence": 1,
  "RuleEnable": "on",
  "Rule": "(http.host eq \"video.example.com\")\n",
  "RuleName": "rule_example",
  "ResponseHeaderModification": [
    {
      "Name": "headerName",
      "Operation": "add",
      "Value": "headerValue",
      "Type": "static"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400InternalExceptionFailed to call the service. Try again later or contact technical support.Failed to call the service. Try again later or contact technical support.

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

Change history

Change timeSummary of changesOperation
2025-12-11The Error code has changedView Change Details