All Products
Search
Document Center

Security Center:DescribeWebLockConfigList

Last Updated:Jan 28, 2023

Queries the configurations of web tamper proofing for a specified server.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address of the request.

1.2.3.4
LangstringNo

The language of the content within the request and the response. Valid values:

  • zh: Chinese
  • en: English
zh
UuidstringYes

The UUID of the server for which you want to query the configurations.

inet-1234567****

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

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

1
RequestIdstring

The ID of the request.

D9354C1A-D709-4873-9AAE-41513327B247
ConfigListarray

An array that consists of the configurations of web tamper proofing.

object
ExclusiveDirstring

The directory that has web tamper proofing disabled.

NoteIf the value of Mode is blacklist, this parameter is returned.
/home/admin/tomcat
Uuidstring

The UUID of the server that has web tamper proofing enabled.

80d2f7d6-31a9-4d7f-8ff4-7ecc42f8****
InclusiveFileTypestring

The type of the file that has web tamper proofing enabled.

NoteIf the value of Mode is whitelist, this parameter is returned.
jpg
DefenceModestring

The prevention mode. Valid values:

  • block: Interception Mode
  • audit: Alert Mode
audit
ExclusiveFileTypestring

The type of the file that has web tamper proofing disabled.

NoteIf the value of Mode is blacklist, this parameter is returned.
*.jpg
InclusiveFilestring

The file that has web tamper proofing enabled.

NoteIf the value of Mode is whitelist, this parameter is returned.
/home/admin/tomcat/aaa.log
Modestring

The protection mode of web tamper proofing. Valid values:

  • whitelist: In this mode, web tamper proofing is enabled for the specified directories and file types.
  • blacklist: In this mode, web tamper proofing is enabled for the unspecified sub-directories, file types, and files in the protected directories.
blacklist
Dirstring

The directory that has web tamper proofing enabled.

/www/tmp/
ExclusiveFilestring

The file that has web tamper proofing disabled.

NoteIf the value of Mode is blacklist, this parameter is returned.
/home/admin/tomcat/localhost.log
Idstring

The ID of the directory that has web tamper proofing enabled.

11
LocalBackupDirstring

The local path to the backup files of the protected directory.

/usr/local/backup

Example

Normal return example

JSONFormat

{
  "TotalCount": 1,
  "RequestId": "D9354C1A-D709-4873-9AAE-41513327B247",
  "ConfigList": [
    {
      "ExclusiveDir": "/home/admin/tomcat",
      "Uuid": "80d2f7d6-31a9-4d7f-8ff4-7ecc42f8****",
      "InclusiveFileType": "jpg",
      "DefenceMode": "audit",
      "ExclusiveFileType": "*.jpg",
      "InclusiveFile": "/home/admin/tomcat/aaa.log",
      "Mode": "blacklist",
      "Dir": "/www/tmp/",
      "ExclusiveFile": "/home/admin/tomcat/localhost.log",
      "Id": "11",
      "LocalBackupDir": "/usr/local/backup"
    }
  ]
}

Error codes

Http codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500InternalErrorThe request processing has failed due to some unknown error.-
500ServerErrorServerError-

For a list of error codes, visit the API error center.