DescribeCustomBlockInstances - Security Center - Alibaba Cloud Documentation Center

Queries the list of servers on which the custom defense rule against brute-force attacks takes effect.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:DescribeCustomBlockInstances	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
CurrentPage	integer	No	The page number. Default value: 1.	8
Status	integer	No	Specifies whether the rule is enabled for the server. 2: enabling failed 1: enabled 0: disabled	1
BlockIp	string	No	The IP address that you want to specify in the rule. Note You can call the DescribeCustomBlockRecords operation to obtain the IP address.	47.92.33.1xx
PageSize	integer	No	The number of entries per page. Default value: 20.	20
Bound	string	No	The traffic direction that you want to specify in the custom rule. Valid values: in: inbound out: outbound	in

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	D81DD78E-E006-5C65-A171-C8CB09XXXXX
PageInfo	object	The pagination information.
CurrentPage	integer	The page number.	1
PageSize	integer	The number of entries per page. Default value: 20.	20
TotalCount	integer	The total number of servers to which the defense rule is applied.	83
Count	integer	The number of entries returned on the current page.	10
InstanceList	array<object>	The server ID.
InstanceRecord	object
Status	integer	Indicates whether the rule is enabled for the server. 2: enabling failed 1: enabled 0: disabled	1
Uuid	string	The UUID of the server.	f2d6e901-1004-4ca8-9dae-53ec04a9****
InternetIp	string	The public IP address of the server.	116.62.121.1xx
IntranetIp	string	The private IP address of the server.	192.168.1.xx
InstanceName	string	The name of the asset.	myInstance
BlockType	string	The blocking type. Valid values: group: security group alinet: host network extension	group
ErrorCode	string	The error code returned.	AliNetNotOnline
SuccessInfo	string	The information that is returned after brute-force attacks are blocked.	{"aliUid":*******,"groupId":"sg-xxxx","groupName":"Sas_Malicious_Ip_Security_Group","groupType":"normal","instanceId":"i-xxxx","regionId":"cn-shenzhen","vpcId":"vpc-xxxxxxxx"}
AliNetOnline	boolean	The status of the host network extension. Valid values: true: online false: offline	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "D81DD78E-E006-5C65-A171-C8CB09XXXXX",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 83,
    "Count": 10
  },
  "InstanceList": [
    {
      "Status": 1,
      "Uuid": "f2d6e901-1004-4ca8-9dae-53ec04a9****",
      "InternetIp": "116.62.121.1xx",
      "IntranetIp": "192.168.1.xx",
      "InstanceName": "myInstance",
      "BlockType": "group",
      "ErrorCode": "AliNetNotOnline",
      "SuccessInfo": "{\"aliUid\":*******,\"groupId\":\"sg-xxxx\",\"groupName\":\"Sas_Malicious_Ip_Security_Group\",\"groupType\":\"normal\",\"instanceId\":\"i-xxxx\",\"regionId\":\"cn-shenzhen\",\"vpcId\":\"vpc-xxxxxxxx\"}",
      "AliNetOnline": true
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

For a list of error codes, visit the Service error codes.