All Products
Search
Document Center

Security Center:ListSystemAggregationRules

Last Updated:Nov 25, 2024

Queries the details about the aggregation types of system defense rules.

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

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 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 rules.

integerNo

The type of the rules. Valid values:

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

The type of the operating system. Valid values:

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

The IDs of the aggregation types.

integerNo

The ID of the aggregation type.

1

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

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

6800B790-B10A-5C2F-BEB3-F1D5CE61****
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.

30
AggregationListarray<object>

An array that consists of the details about the aggregation types.

AggregationListobject

The details about the aggregation type.

Idinteger

The ID of the aggregation type.

1
RuleCountinteger

The number of rules that are of the aggregation type.

0
Namestring

The name of the aggregation type.

Remote control\*\*\*\*

Examples

Sample success responses

JSONformat

{
  "RequestId": "6800B790-B10A-5C2F-BEB3-F1D5CE61****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 30
  },
  "AggregationList": [
    {
      "Id": 1,
      "RuleCount": 0,
      "Name": "Remote control\\*\\*\\*\\*\n"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.-
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