All Products
Search
Document Center

Security Center:ModifyWebLockStart

Last Updated:Jun 16, 2026

Creates web tamper proofing protection for a specified server and enables the protection.

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-sas:ModifyWebLockStart

update

*WebLockBind

acs:yundun-sas:{#regionId}:{#accountId}:weblockbind/{#Uuid}

None None

Request parameters

Parameter

Type

Required

Description

Example

Mode

string

Yes

The protection type. Valid values:

  • whitelist: whitelist mode. Protects the specified protection directories and file types.

  • blacklist: blacklist mode. Protects all subdirectories, file types, and specified files in the protection directories that are not excluded.

whitelist

LocalBackupDir

string

Yes

The local backup path used to back up the protection directories. The format of the protection directory path may differ between Linux servers and Windows servers. Make sure that you enter the path in the correct format. The following examples show the directory formats:

  • Linux server: /usr/local/aegis/bak

  • Windows server: C:\Program Files (x86)\Alibaba\Aegis\bak.

/usr/local/backup

ExclusiveFile

string

No

The files that do not require web tamper proofing protection (excluded files).

Note

This parameter is required when the Defense mode Mode is set to the blacklist pattern.

/home/admin/tomcat/localhost.log

Dir

string

Yes

The protection directories. Separate multiple directories with commas (,).

/home/admin/tomcat

InclusiveFileType

string

No

The file types that require web tamper proofing protection. Separate multiple file types with commas (,). Valid values:

  • php

  • jsp

  • asp

  • aspx

  • js

  • cgi

  • html

  • htm

  • xml

  • shtml

  • shtm

  • jpg

  • gif

  • png

Note

This parameter is required when the Defense mode Mode is set to the whitelist pattern.

php

Uuid

string

Yes

The UUID of the server that you want to protect.

80d2f7d6-31a9-4d7f-8ff4-7ecc42f89ca****

ExclusiveFileType

string

No

The file types that do not require web tamper proofing protection (excluded file types). Separate multiple file types with commas (,). Valid values:

  • php

  • jsp

  • asp

  • aspx

  • js

  • cgi

  • html

  • htm

  • xml

  • shtml

  • shtm

  • jpg

  • gif

  • png

Note

This parameter is required when the Defense mode Mode is set to the blacklist pattern.

jpg

ExclusiveDir

string

No

The folder that does not require web tamper proofing protection (excluded folder).

Note

This parameter is required when the Defense mode Mode is set to the blacklist pattern.

/home/admin/java

DefenceMode

string

Yes

The defense mode. Valid values:

  • block: block

  • audit: alert.

block

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.

D9354C1A-D709-4873-9AAE-41513327B247

Examples

Success response

JSON format

{
  "RequestId": "D9354C1A-D709-4873-9AAE-41513327B247"
}

Error codes

HTTP status code

Error code

Error message

Description

400 IllegalParam Illegal param
400 DuplicatedDirectory Duplicated directory
400 NeedBuy This service shoule be purchased first.
400 DefenceEmptyConfig At least one protection directory is needed.
400 DefenceAuthLimit The number of machines has reached the upper limit.
400 BindDataExist The binding data already exists.
400 MissingDir Dir is mandatory for this action.
500 InternalError The request processing has failed due to some unknown error.
500 ServerError ServerError
403 NoPermission caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.