Automate HTTP Response Header Rules with ESA API - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration: Central de Documentação do Alibaba Cloud

Updates the HTTP incoming response header modification configuration 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:UpdateHttpIncomingResponseHeaderModificationRule

update

*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.	498607398028944
ConfigId	integer	Yes	The configuration ID. You can call the ListHttpIncomingResponseHeaderModificationRules operation to obtain the configuration ID.	352816096987136
RuleName	string	No	The rule name. This parameter is not required when adding a global configuration.	rule_example
RuleEnable	string	No	The rule switch. This parameter is not required when adding a global configuration. Valid values: on: Enabled. off: Disabled. Valid values: off : off on : on	on
Rule	string	No	The rule content, which uses a conditional expression to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios: 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")
ResponseHeaderModification	array<object>	No	The response header modifications. Three operation types are supported: add, delete, and modify.
	object	No	The response header modification details.
Name	string	Yes	The response header name.	headerName
Operation	string	Yes	The operation type. Valid values: add: Add. del: Delete. modify: Modify. Valid values: add : add modify : modify del : del	add
Value	string	No	The response header value.	headerValue
Type	string	No	The value type. Valid values: static: Static pattern. dynamic: Dynamic schema. Valid values: static : static dynamic : dynamic	static
Sequence	integer	No	The rule execution order. A smaller value indicates a higher priority.	1

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	15C66C7B-671A-4297-9187-2C4477247A74

Examples

Success response

JSON format

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

HTTP status code	Error code	Error message	Description
400	ApplyVipError	Failed to apply for ip resources, please contact customer service.	Failed to apply for IP resources, please contact customer service.
400	CanNotSetSequence	Non-regular configuration, you cannot set Sequence parameters.	Sequence parameters is not allowed in global configuration.
400	CacheReserveSiteExceedLimit	The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.	The number of sites for which the cache reserve instance bindings exceeds the limit.
400	CompileRuleError	Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.	Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.
400	SiteConfigLengthExceedLimit	The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.	The size of the site configuration exceeds the limit, and the total size cannot exceed 512K.
400	ConfigConflicts	Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.	The parameter uniqueness check failed. Check for duplicate parameter values.
400	RuleRegexQuotaCheckFailed	When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.	The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.
400	NestedRuleQuotaCheckFailed	The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.	The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.
400	ArgQuotaCheckFailed	The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.	The current plan does not support the configuration of restricted parameters, please check the input parameters.
400	ServiceInvokeFailed	The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.	Failed to call the service. Please try again later or contact customer service for details.
400	FunctionConflict	The feature configuration conflicts. Sites with version management enabled cannot configure this feature.	The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.
400	SpecifiedVersionReadOnly	The specified version number is read-only and cannot be modified.	The specified version number is read-only and cannot be modified.
400	VersionNotValid	The site does not have version management enabled, or the version number passed in does not exist.	The site does not have version management enabled, or the version number passed in does not exist.
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.ArgName	Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.	Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.
400	InvalidParameter.ArgValue	Invalid parameter value. Check whether the value format and length meet the requirements.	Invalid parameter value. Check whether the value format and length meet the requirements.
400	InvalidParameter.Configs	Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.	Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.
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.
400	InstanceNotExist	The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.	The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.
400	LockFailed	The system is handling requests you previously submitted. Try again later.	The system is handling requests you previously submitted. Try again later.
400	IllegalOperation.VersionManagement	The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.	The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.
400	QuotaCheckFailed.VersionManagement	Insufficient quota for version management. Contact technical support.	Insufficient quota for version management. Contact technical support.
400	InvalidConfigId	The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.	The ConfigId does not exist.
400	Instance.NotOnline	Your plan is unavailable due to an overdue payment. Complete the payment first.	Your plan is unavailable due to an overdue payment. Complete the payment first.
400	CachceReserveInstanceCheckFalied	If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.	If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.
400	VerifyExpressionError	Dynamic expression is invalid.	Dynamic expression is invalid.
400	InvalidValOfDelHeader	The delete header operation does not support setting value.	The delete header operation does not support setting value.
400	MissingParameter	The specified ArgName is required for this function.	When configuring a specific function, the required parameter is missing.
400	FunctionArgError	Failed to check the configured function parameters.	Failed to check the configured function parameters
404	SiteNotFound	The website does not exist or does not belong to you.	The website does not exist or does not belong to you.