All Products
Search
Document Center

Web Application Firewall:ModifyDefenseResourceXff

Last Updated:Aug 20, 2026

Modifies the client IP and cookie settings of a protected object.

Operation description

Before you invoke this operation, make sure that a protected object has been added to WAF. You can invoke the CreateDomain operation to create a CNAME-based resource, invoke the CreateCloudResource operation to create a cloud native mode resource, or invoke the CreateDefenseResource operation to create a custom protected object. You can invoke the DescribeDefenseResources operation to query the protected objects that have been added to WAF.

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

yundun-waf:ModifyDefenseResourceXff

update

*DefenseResource

acs:yundun-waf:{#regionId}:{#accountId}:defenseresource/{#Resource}

None None

Request parameters

Parameter

Type

Required

Description

Example

XffStatus

integer

Yes

Specifies whether a Layer 7 proxy (Anti-DDoS Pro, CDN, or similar) is deployed in front of WAF. Valid values:

  • 0 (default): No Layer 7 proxy is deployed.

  • 1: A Layer 7 proxy is deployed.

0

InstanceId

string

Yes

Instance ID of the WAF instance.

Note

You can call the DescribeInstance operation to query instance ID of the WAF instance.

waf_v2_public_cn-wwo****ek07

CustomHeaders

array

No

The list of specified header fields.

Note

The first IP address in the specified header field is used as the client source IP address to prevent XFF spoofing. If multiple headers are specified, the system attempts to obtain the source IP address from the headers in order. If the first header does not contain an IP address, the system tries the second header, and so on. If none of the specified headers contain an IP address, the first IP address in the X-Forwarded-For header is used.

string

No

The specified header field.

x-forwarded-for

Resource

string

Yes

The name of the protected object.

Note

The protected object must have been added to WAF. You can call the DescribeDefenseResources operation to query the name of the protected object.

alb-4pxu81fgagx3h6y****-alb

AcwCookieStatus

integer

No

The status of the tracking cookie switch.

  • 0: disabled.

  • 1 (default): enabled.

0

AcwSecureStatus

integer

No

The status of the secure attribute of the tracking cookie.

  • 0 (default): disabled.

  • 1: enabled.

0

AcwV3SecureStatus

integer

No

The status of the secure attribute of the slider cookie.

  • 0 (default): disabled.

  • 1: enabled.

0

RegionId

string

No

The region where the WAF instance is deployed. Valid values:

  • cn-hangzhou: the Chinese mainland.

  • ap-southeast-1: outside the Chinese mainland.

cn-hangzhou

ResponseHeaders

array<object>

No

The response header parameters.

object

No

The response header parameters.

Key

string

No

The key of the custom response header.

Header-Key

Value

string

No

The value of the custom response header.

Header-Value

ResourceManagerResourceGroupId

string

No

The ID of the Alibaba Cloud resource group.

rg-acfm2ki****miwq

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

6C094583-9B3F-5BD8-8748-DC638E48****

Examples

Success response

JSON format

{
  "RequestId": "6C094583-9B3F-5BD8-8748-DC638E48****"
}

Error codes

HTTP status code

Error code

Error message

Description

400 Waf.Pullin.AbnormalStatus The status of the access resource is abnormal. Resource:%s. The status of the access resource is abnormal. Resource:%s.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.