All Products
Search
Document Center

Security Center:ListSystemClientRules

Last Updated:Jan 28, 2023

Queries system defense rules.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

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

  • zh: Chinese
  • en: English
zh
RuleNamestringNo

The name of the system defense rule.

Rule\*\*\*\*
CurrentPageintegerYes

The number of the page to return.

1
PageSizeintegerYes

The number of entries to return on each page.

20
RuleTypesarrayNo

The types of the system defense rules.

integerNo

The type of the system defense rule. Valid values:

  • 0: process-specific defense
  • 1: network-specific defense
1
SystemTypeintegerNo

The type of the operating system. Valid values:

  • 2: Windows
  • 1: Linux
  • 0: all types
0
AggregationIdsarrayNo

The IDs of the aggregation types for rules.

integerNo

The ID of the aggregation type for the rule.

38
IsContainerintegerNo

Specifies whether to query only container images. Valid values:

  • 0: no
  • 1: yes
1

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

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

C43CA30F-EF67-51BB-8C95-F31B8303****
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.

17
RuleListarray

An array that consists of the rules.

object

The details of the rule.

Statusinteger

The status of the rule. Valid values:

  • online: enabled
  • offline: disabled
online
RuleTypeinteger

The type of the rule. Valid values:

  • 1: alihips
  • 2: alinet
  • 3: alidetect
  • 4: alisecguard
alihips
Platformstring

The type of the operating system. Valid values:

  • windows: Windows
  • linux: Linux
  • all: all types
linux
SwitchIdstring

The switch ID of the rule.

USER-ENABLE-SWITCH-TYPE_****
RuleIdlong

The ID of the rule.

30****
RuleNamestring

The name of the rule.

Rule\*\*\*\*
AggregationNamestring

The name of the aggregation type for the rule.

Initial entry
Descriptionstring

The description of the rule.

Supports alerting or blocking of images that have high-risk vulnerabilities\*\*\*\*
Policiesarray

An array that consists of the policies.

object

The information about the policy.

PolicyNamestring

The name of the policy.

System self-starting task\*\*\*\*
PolicyKeystring

The policy key.

system_auto_****

Example

Normal return example

JSONFormat

{
  "RequestId": "C43CA30F-EF67-51BB-8C95-F31B8303****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 17
  },
  "RuleList": [
    {
      "Status": 0,
      "RuleType": 0,
      "Platform": "linux",
      "SwitchId": "USER-ENABLE-SWITCH-TYPE_****",
      "RuleId": 0,
      "RuleName": "Rule\\*\\*\\*\\*\n",
      "AggregationName": "Initial entry\n",
      "Description": "Supports alerting or blocking of images that have high-risk vulnerabilities\\*\\*\\*\\*\n",
      "Policies": [
        {
          "PolicyName": "System self-starting task\\*\\*\\*\\*\n",
          "PolicyKey": "system_auto_****"
        }
      ]
    }
  ]
}

Error codes

Http codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the API error center.