All Products
Search
Document Center

Security Center:DescribeCustomBlockRecords

Last Updated:Nov 25, 2024

Queries the defense rules against brute-force attacks that are applied to one or more servers.

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.

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:DescribeCustomBlockRecordsget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CurrentPageintegerNo

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

1
StatusintegerNo

The status of the defense rule. Valid values:

  • 0: invalid
  • 1: enabled
  • 2: failed
1
BlockIpstringNo

The IP address that you want to block by using the defense rule.

117.66.XX.XX
PageSizeintegerNo

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

20

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

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

028CF634-5268-5660-9575-48C9ED6B7T8Y
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

20
TotalCountinteger

The total number of entries returned.

708
Countinteger

The number of entries returned on the current page.

3
RecordListarray<object>

An array that consists of the defense rules.

CustomRecordobject

The information about the server.

Statusinteger

The status of the defense rule against brute-force attacks. Valid values:

  • 0: invalid.
  • 1: enabled.
  • 2: failed.
1
BlockExpireDatelong

The timestamp generated when the block action on the IP address becomes invalid.

1671506882063
EnableCountinteger

The number of servers for which the defense rule is enabled.

4
ServerCountinteger

The total number of servers on which the IP address is blocked.

6
BlockIpstring

The blocked IP address.

45.227.XX.XX
Boundstring

The direction of the traffic that is sent by the blocked IP address. Valid values:

  • in
  • out
in
Sourcestring

The source of the defense rule.

UserRule
Idlong

The record ID.

353376
TargetListarray<object>

The servers for which the defense rule is enabled.

Targetobject

The information about the server.

Targetstring

The ID of the destination asset.

032b618f-b220-4a0d-bd37-fbdc6*******
TargetTypestring

The type of the query. Valid values:

  • Set the value to uuid.
uuid

Examples

Sample success responses

JSONformat

{
  "RequestId": "028CF634-5268-5660-9575-48C9ED6B7T8Y",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 708,
    "Count": 3
  },
  "RecordList": [
    {
      "Status": 1,
      "BlockExpireDate": 1671506882063,
      "EnableCount": 4,
      "ServerCount": 6,
      "BlockIp": "45.227.XX.XX\n",
      "Bound": "in",
      "Source": "UserRule",
      "Id": 353376,
      "TargetList": [
        {
          "Target": "032b618f-b220-4a0d-bd37-fbdc6*******",
          "TargetType": "uuid"
        }
      ]
    }
  ]
}

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.

Change history

Change timeSummary of changesOperation
No change history