All Products
Search
Document Center

Security Center:ListMaliciousFileWhitelistConfigs

Last Updated:Feb 20, 2024

Queries the alert whitelist rules of sensitive files that are detected by using the agentless detection feature.

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
SourcestringNo

The feature to which this operation belongs. If you leave this parameter empty, the default value agentless is used.

agentless
LangstringNo

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

  • zh: Chinese
  • en: English
zh
CurrentPageintegerNo

The page number. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

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

20
EventNamestringNo

The name of the alert.

  • Set the value to ALL, which indicates all alert types.
ALL

Response parameters

ParameterTypeDescriptionExample
object

PageResult

Listobject []

The alert whitelist rules of sensitive files that are detected by using the agentless detection feature.

GmtCreatestring

The time when the rule was created.

1691719662000
GmtModifiedstring

The time when the rule was modified.

1691719662000
EventNamestring

The name of the alert.

  • The value is fixed as ALL, which indicates all alert types.
ALL
Fieldstring

The field that is used in the whitelist rule.

fileMd5
FieldValuestring

The value of the field that is used in the whitelist rule.

b2cf9747ee49d8d9b105cf16e078cc16
Operatorstring

The logical operator of the whitelist rule.

  • The value is fixed as strEqual, which indicates the equality operator (=).
strEqual
TargetValuestring

The assets on which the rule takes effect. Valid values:

  • ALL: all assets
  • Others: selected assets
ALL
TargetTypestring

The type of the assets on which the rule takes effect. Valid values:

  • ALL: all assets
  • SELECTION_KEY: selected assets
ALL
Countstring

The number of the assets on which the rule takes effect.

Note The value of this parameter is returned only if the value of TargetType is SELECTION_KEY.
ALL
Sourcestring

The feature to which this operation belongs.

  • The value is fixed as agentless, which indicates the agentless detection feature.
agentless
Idlong

The ID of the rule.

1
PageInfoobject

The pagination information.

CurrentPageinteger

The page number.

1
PageSizeinteger

The number of entries per page.

20
TotalCountinteger

The total number of entries returned.

29
Countinteger

The number of entries returned on the current page.

9
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Codestring

The response code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.

200
Messagestring

The returned message.

successful
RequestIdstring

The request ID.

F5CF78A7-30AA-59DB-847F-13EE3AE7****
HttpStatusCodeinteger

The HTTP status code.

200

Examples

Sample success responses

JSONformat

{
  "List": [
    {
      "GmtCreate": "1691719662000",
      "GmtModified": "1691719662000",
      "EventName": "ALL",
      "Field": "fileMd5",
      "FieldValue": "b2cf9747ee49d8d9b105cf16e078cc16",
      "Operator": "strEqual",
      "TargetValue": "ALL",
      "TargetType": "ALL",
      "Count": "ALL",
      "Source": "agentless",
      "Id": 1
    }
  ],
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 29,
    "Count": 9
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "F5CF78A7-30AA-59DB-847F-13EE3AE7****",
  "HttpStatusCode": 200
}

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionno permission-
400UnknownErrorUnknownError-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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