DescribeWebLockBindList API Reference - Security Center - Alibaba Cloud - Security Center

Retrieves the list of servers that have web tamper-proofing protection enabled.

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:DescribeWebLockBindList

get

*WebLockBind

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

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The IP address of the access source.	116.30.XX.XX
Lang	string	No	The language of the request and response. Valid values: zh: Chinese en: English.	zh
Remark	string	No	The fuzzy match field for the server. The value can be a server name or IP address.	192.168.XX.XX
Status	string	No	The protection status of the servers that you want to query. Valid values: on: Protection is enabled. off: Protection is disabled.	on
CurrentPage	integer	No	The page number of the current page in a paging query. Minimum value: 1. Default value: 1.	1
PageSize	integer	No	The maximum number of entries per page in a paging query. Default value: 20.	20
Uuid	string	No	The UUID of the asset that you want to query. Note Call the DescribeCloudCenterInstances operation to obtain this parameter.	7151f27e-1d51-4e98-a540-8936a****

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The page number of the current page in a paging query. Minimum value: 1. Default value: 1.	1
RequestId	string	The ID of the request. The China value is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting.	D9354C1A-D709-4873-9AAE-41513327B247
PageSize	integer	The maximum number of entries per page in a paging query. Default value: 20.	20
TotalCount	integer	The total number of servers attached to web tamper-proofing.	11409
BindList	array<object>	The collection of servers that have web tamper-proofing protection enabled.
	object	The information about a server that has web tamper-proofing protection enabled.
Status	string	The protection status of the server. Valid values: on: Protection is enabled. off: Protection is disabled.	on
Percent	integer	The startup progress of web tamper-proofing protection, in percentage. Value range: 0 to 100%.	99
InternetIp	string	The public IP address of the server.	54.169.XX.XX
ServiceDetail	string	The details of the web tamper-proofing service exception. Valid values: client offline: The client is offline. timeout: The connection timeout.	client offline
Os	string	The operating system type of the server.	Linux
ServiceStatus	string	The web tamper-proofing service status of the server. Valid values: stop: The tamper-proofing service is not started. initializing: The tamper-proofing service is starting. exception: The tamper-proofing service is abnormal. running: The tamper-proofing service is running. closing: The tamper-proofing service is undergoing shutdown.	stop
IntranetIp	string	The private IP address of the server.	192.168.XX.XX
AuditCount	string	The number of alerts.	2
Uuid	string	The UUID of the server.	inet-12345****
ServiceCode	string	The error code for the web tamper-proofing service exception. Valid values: 2001: The client is offline. 9999: The connection timeout.	2001
InstanceName	string	The name of the server.	testName
DirCount	string	The number of protected directories.	5
BlockCount	string	The number of blocked events.	10

Examples

Success response

JSON format

{
  "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 status code	Error code	Error message
400	NoPermission	no permission
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.