All Products
Search
Document Center

Security Center:DescribeWebLockConfigList

Last Updated:Feb 20, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeWebLockConfigListRead
  • All Resources
    *
    none
none

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 response. Valid values:

  • zh: Chinese
  • en: English
zh
UuidstringYes

The UUID of the server.

inet-1234567****

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

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

1
RequestIdstring

The ID of the request.

D9354C1A-D709-4873-9AAE-41513327B247
ConfigListobject []

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

ExclusiveDirstring

The directory that has web tamper proofing disabled.

Note If 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.

Note If 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.

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

The file that has web tamper proofing enabled.

Note If 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 subdirectories, file types, and files in the protected directory.
blacklist
Dirstring

The directory that has web tamper proofing enabled.

/www/tmp/
ExclusiveFilestring

The file that has web tamper proofing disabled.

Note If 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

Examples

Sample success responses

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 status 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 Service error codes.

Change history

Change timeSummary of changesOperation
No change history