You can call this operation to query the tamper protection configurations of a specific server.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeWebLockConfigList

The operation that you want to perform.

Set the value to DescribeWebLockConfigList.

SourceIp String No 1.2.3.4

The source IP address of the request.

Lang String No zh

The language of the request and response. Valid values:

  • zh: Chinese
  • en: English
Uuid String No inet-1234567****

The UUID of the server to be queried.

Response parameters

Parameter Type Example Description
ConfigList Array

The list of tamper protection configurations.

Dir String /www/tmp/

The directory that has tamper protection enabled.

ExclusiveDir String /home/admin/tomcat

The directory that has tamper protection disabled.

Note If the value of Mode is blacklist, this parameter is returned.
ExclusiveFile String /home/admin/tomcat/localhost.log

The file that has tamper protection disabled.

Note If the value of Mode is blacklist, this parameter is returned.
ExclusiveFileType String *.jpg

The type of file that has tamper protection disabled.

Note If the value of Mode is blacklist, this parameter is returned.
Id String 11

The ID of the directory that has tamper protection enabled.

InclusiveFile String /home/admin/tomcat/aaa.log

The file that has tamper protection enabled.

Note If the value of Mode is whitelist, this parameter is returned.
InclusiveFileType String jpg

The type of file that has tamper protection enabled.

Note If the value of Mode is whitelist, this parameter is returned.
LocalBackupDir String /usr/local/backup

The local path where backup files of the protected directory are stored.

Mode String blacklist

The protection mode. Valid values:

  • whitelist: In this mode, tamper protection is enabled for the specified directories and file types.
  • blacklist: In this mode, tamper protection is enabled for the unspecified sub-directories, file types, and files under the protected directory.
Uuid String 80d2f7d6-31a9-4d7f-8ff4-7ecc42f8****

The UUID of the server that has tamper protection enabled.

RequestId String D9354C1A-D709-4873-9AAE-41513327B247

The ID of the request.

TotalCount Integer 1

The total number of directories that have tamper protection enabled on the specified server.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeWebLockConfigList
&<Common request parameters>

Sample success responses

XML format

<DescribeWebLockConfigListResponse>
      <TotalCount>1</TotalCount>
      <RequestId>EB7BD248-FBD6-4378-B244-0C9FB299BCBC</RequestId>
      <ConfigList>
            <InclusiveFileType>php;jsp;asp;aspx;js;cgi;html;htm;xml;shtml;shtm;jpg;gif;png</InclusiveFileType>
            <ExclusiveFile></ExclusiveFile>
            <Uuid>80d2f7d6-31a9-4d7f-8ff4-7ecc42f8****</Uuid>
            <ExclusiveDir></ExclusiveDir>
            <Mode>whitelist</Mode>
            <LocalBackupDir>/usr/local/aegis/bak</LocalBackupDir>
            <ExclusiveFileType></ExclusiveFileType>
            <Id>9312</Id>
            <Dir>/www/tmp/</Dir>
            <InclusiveFile></InclusiveFile>
      </ConfigList>
</DescribeWebLockConfigListResponse>

JSON format

{
	"TotalCount": 1,
	"RequestId": "EB7BD248-FBD6-4378-B244-0C9FB299BCBC",
	"ConfigList": [
		{
			"InclusiveFileType": "php;jsp;asp;aspx;js;cgi;html;htm;xml;shtml;shtm;jpg;gif;png",
			"ExclusiveFile": "",
			"Uuid": "80d2f7d6-31a9-4d7f-8ff4-7ecc42f8****",
			"ExclusiveDir": "",
			"Mode": "whitelist",
			"LocalBackupDir": "/usr/local/aegis/bak",
			"ExclusiveFileType": "",
			"Id": 9312,
			"Dir": "/www/tmp/",
			"InclusiveFile": ""
		}
	]
}

Error codes

For a list of error codes, visit the API Error Center.