All Products
Search
Document Center

Security Center:DescribeCustomBlockInstances

Last Updated:Feb 20, 2024

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

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
CurrentPageintegerNo

The page number. Default value: 1.

8
StatusintegerNo

Specifies whether the rule is enabled for the server.

  • 2: enabling failed
  • 1: enabled
  • 0: disabled
1
BlockIpstringNo

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
PageSizeintegerNo

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

20
BoundstringNo

The traffic direction that you want to specify in the custom rule. Valid values:

  • in: inbound
  • out: outbound
in

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

D81DD78E-E006-5C65-A171-C8CB09XXXXX
PageInfoobject

The pagination information.

CurrentPageinteger

The page number.

1
PageSizeinteger

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

20
TotalCountinteger

The total number of servers to which the defense rule is applied.

83
Countinteger

The number of entries returned on the current page.

10
InstanceListobject []

The server ID.

Statusinteger

Indicates whether the rule is enabled for the server.

  • 2: enabling failed
  • 1: enabled
  • 0: disabled
1
Uuidstring

The UUID of the server.

f2d6e901-1004-4ca8-9dae-53ec04a9****
InternetIpstring

The public IP address of the server.

116.62.121.1xx
IntranetIpstring

The private IP address of the server.

192.168.1.xx
InstanceNamestring

The name of the asset.

myInstance
BlockTypestring

The blocking type. Valid values:

  • group: security group
  • alinet: host network extension
group
ErrorCodestring

The error code returned.

AliNetNotOnline
SuccessInfostring

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"}
AliNetOnlineboolean

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 codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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