All Products
Search
Document Center

Security Center:ListFileProtectRule

Last Updated:Sep 24, 2024

Queries core file monitoring rules.

Debugging

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

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

Request parameters

ParameterTypeRequiredDescriptionExample
PageSizeintegerNo

The number of entries per page.

10
CurrentPageintegerNo

The page number.

1
RuleNamestringNo

The name of the rule.

test-rule-1
AlertLevelintegerNo

The severity of alerts. Valid values:

  • 0: does not generate alerts
  • 1: sends notifications
  • 2: suspicious
  • 3: high-risk
0
RuleActionstringNo

The handling method of the rule. Valid values:

  • pass: allow
  • alert
pass

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

FBBEB173-1F43-505F-A876-C03ECDF6CE4C
PageInfoobject

The pagination information.

CurrentPageinteger

The page number.

1
PageSizeinteger

The number of entries per page.

20
TotalCountinteger

The total number of entries returned.

253
FileProtectListarray<object>

The details of returned data.

Ruleobject
Statusinteger

The status of the rule. Valid values:

  • 0: disabled
  • 1: enabled
1
AlertLevelstring

The severity of alerts. Valid values:

  • 0: does not generate alerts
  • 1: sends notifications
  • 2: suspicious
  • 3: high-risk
0
SwitchIdstring

The switch ID of the rule.

FILE_PROTECT_RULE_SWITCH_TYPE_1693474122927
Idlong

The ID of the rule.

1412511
FileOpsarray

The operations performed on the files.

fileOpsstring

The operation performed on the file. Valid values:

  • WRITE
  • READ
  • DELETE
  • RENAME
  • CHMOD: change permissions
READ
Actionstring

The handling method of the rule. Valid values:

  • pass: allow
  • alert
pass
FilePathsarray

The paths to the monitored files. Wildcard characters are supported.

procPathsstring

The path to the monitored file.

/usr/*
ProcPathsarray

The paths to the monitored processes. Wildcard characters are supported.

procPathsstring

The path to the monitored process.

/usr/local/*
RuleNamestring

The name of the rule.

test11
GmtCreatelong

The time when the rule was created.

1682304179000
GmtModifiedlong

The time when the rule was last modified.

1682304179000
EffectInstanceCountlong

The total number of affected assets.

12
Platformstring

The type of the operating system. Valid values:

  • windows: Windows
  • linux: Linux
linux

Examples

Sample success responses

JSONformat

{
  "RequestId": "FBBEB173-1F43-505F-A876-C03ECDF6CE4C",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 253
  },
  "FileProtectList": [
    {
      "Status": 1,
      "AlertLevel": "0",
      "SwitchId": "FILE_PROTECT_RULE_SWITCH_TYPE_1693474122927",
      "Id": 1412511,
      "FileOps": [
        "READ"
      ],
      "Action": "pass",
      "FilePaths": [
        "/usr/*"
      ],
      "ProcPaths": [
        "/usr/local/*"
      ],
      "RuleName": "test11",
      "GmtCreate": 1682304179000,
      "GmtModified": 1682304179000,
      "EffectInstanceCount": 12,
      "Platform": "linux"
    }
  ]
}

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
2024-09-02The request parameters of the API has changed. The response structure of the API has changedView Change Details