All Products
Search
Document Center

Security Center:DescribeWebLockBindList

Last Updated:Jan 28, 2023

Queries the information about the servers that have web tamper proofing enabled.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address of the request.

116.30.XX.XX
LangstringNo

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

  • zh: Chinese
  • en: English
zh
RemarkstringNo

The string that allows you to search for servers in fuzzy match mode. You can enter a server name or IP address.

192.168.XX.XX
StatusstringNo

The protection status of the server that you want to query. Valid values:

  • on: protected
  • off: unprotected
on
CurrentPageintegerNo

The number of the page to return. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Default value: 20.

20

Response parameters

ParameterTypeDescriptionExample
object
CurrentPageinteger

The page number of the returned page. Pages start from page 1. Default value: 1.

1
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

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

The number of entries returned per page. Default value: 20.

20
TotalCountinteger

The total number of servers that have web tamper proofing enabled.

11409
BindListarray

The information about the servers that have web tamper proofing enabled.

object

The information about the servers that have web tamper proofing enabled.

Statusstring

The protection status of the server. Valid values:

  • on: protected
  • off: unprotected
on
Percentinteger

The starting progress percentage of web tamper proofing. Valid values: 0 to 100.

99
InternetIpstring

The public IP address of the server.

54.169.XX.XX
ServiceDetailstring

The error message for web tamper proofing. Valid values:

  • client offline: The Security Center agent is offline.
  • timeout: The connection timed out.
client offline
Osstring

The operating system that the server runs.

Linux
ServiceStatusstring

The status of web tamper proofing on the server. Valid values:

  • stop: Web tamper proofing is disabled.
  • initializing: Web tamper proofing is being enabled.
  • exception: Web tamper proofing is not running as expected.
  • running: Web tamper proofing is running.
  • closing: Web tamper proofing is being disabled.
stop
IntranetIpstring

The private IP address of the server.

192.168.XX.XX
AuditCountstring

The number of alerts.

2
Uuidstring

The UUID of the server.

inet-12345****
ServiceCodestring

The error code for web tamper proofing. Valid values:

  • 2001: The Security Center agent is offline.
  • 9999: The connection timed out.
2001
InstanceNamestring

The name of the server.

testName
DirCountstring

The number of protected directories.

5
BlockCountstring

The number of blocked tampering events.

10

Example

Normal return example

JSONFormat

{
  "CurrentPage": 1,
  "RequestId": "D9354C1A-D709-4873-9AAE-41513327B247",
  "PageSize": 20,
  "TotalCount": 11409,
  "BindList": [
    {
      "Status": "on",
      "Percent": 99,
      "InternetIp": "54.169.XX.XX",
      "ServiceDetail": "client offline",
      "Os": "Linux",
      "ServiceStatus": "stop",
      "IntranetIp": "192.168.XX.XX",
      "AuditCount": "2",
      "Uuid": "inet-12345****",
      "ServiceCode": "2001",
      "InstanceName": "testName",
      "DirCount": "5",
      "BlockCount": "10"
    }
  ]
}

Error codes

Http codeError codeError message
400NoPermissionno permission
500InternalErrorThe request processing has failed due to some unknown error.
500ServerErrorServerError

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