All Products
Search
Document Center

Security Center:ListCloudSiemCustomizeRules

Last Updated:Dec 28, 2023

Queries custom rules.

Debugging

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

Debug

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:ListCloudSiemCustomizeRulesList
  • acs:yundun-sas::{#accountId}:*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
IdstringNo

The ID of the custom rule.

10223
StartTimelongNo

The beginning of the time range to query. Unit: milliseconds.

1577808000000
EndTimelongNo

The end of the time range to query. Unit: milliseconds.

1577808000000
ThreatLevelarrayNo

The risk level. The value is a JSON array. Valid values:

  • serious: high
  • suspicious: medium
  • remind: low
stringNo

The risk level. The value is a JSON array. Valid values:

  • serious: high
  • suspicious: medium
  • remind: low
["remind","serious"]
AlertTypestringNo

The alert type.

scan
RuleNamestringNo

The name of the rule. The name can contain letters, digits, underscores (_), and periods (.).

waf_scan
RuleTypestringNo

The type of the rule. Valid values:

  • predefine
  • customize
customize
StatusintegerNo

The status of the rule. Valid values:

  • 0: The rule is in the initial state.
  • 10: The simulation data is tested.
  • 15: The business data is being tested.
  • 20: The business data test ends.
  • 100: The rule takes effect.
0
CurrentPageintegerYes

The page number. Pages start from page 1.

1
PageSizeintegerYes

The number of entries per page. The value can be up to 100.

10
RegionIdstringNo

The region in which the data management center of the threat analysis feature resides. Specify this parameter based on the regions in which your assets reside. Valid values:

  • cn-hangzhou: Your assets reside in regions in China.
  • ap-southeast-1: Your assets reside in regions outside China.
cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

PageResponse<List>

Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Codeinteger

The HTTP status code.

200
Messagestring

The returned message.

success
RequestIdstring

The request ID.

9AAA9ED9-78F4-5021-86DC-D51C7511****
Dataobject

The data returned.

PageInfoobject

The pagination information.

CurrentPageinteger

The current page number.

1
PageSizeinteger

The number of entries per page.

10
TotalCountlong

The total number of entries returned.

100
ResponseDataobject []

The detailed data.

Idlong

The ID of the custom rule.

123456789
GmtCreatestring

The time when the custom rule was created.

2021-01-06 16:37:29
GmtModifiedstring

The time when the custom rule was last updated.

2021-01-06 16:37:29
Aliuidlong

The ID of the Alibaba Cloud account in SIEM.

127608589417****
RuleNamestring

The name of the rule.

waf_scan
RuleDescstring

The description of the rule.

this rule is for waf scan
RuleTypestring

The type of the rule. Valid values:

  • predefine
  • customize
customize
ThreatLevelstring

The threat level. Valid values:

  • serious: high
  • suspicious: medium
  • remind: low
remind
AlertTypestring

The type of the risk.

WEBSHELL
AlertTypeMdsstring

The internal code of the risk type.

${siem_rule_type_process_abnormal_command}
LogTypestring

The log type of the rule.

ALERT_ACTIVITY
LogTypeMdsstring

The internal code of the log type.

${sas.cloudsiem.prod.alert_activity}
LogSourcestring

The log source of the rule.

cloud_siem_aegis_sas_alert
LogSourceMdsstring

The internal code of the log source.

${sas.cloudsiem.prod.cloud_siem_aegis_sas_alert}
RuleConditionstring

The query condition of the rule in the JSON format. The HTML escape characters are reversed.

[[{&quot;not&quot;:false,&quot;left&quot;:&quot;alert_name&quot;,&quot;operator&quot;:&quot;=&quot;,&quot;right&quot;:&quot;WEBSHELL&quot;}]]
RuleGroupstring

The log aggregation field of the rule. The value is a JSON string. The HTML escape characters are reversed.

[&quot;asset_id&quot;]
RuleThresholdstring

The threshold configurations of the rule in the JSON format. The HTML escape characters are reversed.

{&quot;aggregateFunction&quot;:&quot;count&quot;,&quot;aggregateFunctionName&quot;:&quot;count&quot;,&quot;field&quot;:&quot;activity_name&quot;,&quot;operator&quot;:&quot;&lt;=&quot;,&quot;value&quot;:1}
QueryCyclestring

The window length of the rule. The HTML escape characters are reversed.

{&quot;time&quot;:&quot;1&quot;,&quot;unit&quot;:&quot;HOUR&quot;}
EventTransferSwitchinteger

Indicates whether the system generates an event for the alert. Valid values:

  • 0: no.
  • 1: yes.
1
EventTransferTypestring

The event generation method. Valid values:

  • default: The default method is used.
  • singleToSingle: The system generates an event for each alert.
  • allToSingle: The system generates an event for alerts within a period of time.
allToSingle
EventTransferExtstring

The extended information about event generation. If the value of eventTransferType is allToSingle, the value of this parameter indicates the length and unit of the alert aggregation window. The HTML escape characters are reversed.

{&quot;time&quot;:&quot;1&quot;,&quot;unit&quot;:&quot;MINUTE&quot;}
Statusinteger

The rule status. Valid values:

  • 0: The rule is in the initial state.
  • 10: The simulation data is tested.
  • 15: The business data is being tested.
  • 20: The business data test ends.
  • 100: The rule takes effect.
0

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "Code": 200,
  "Message": "success",
  "RequestId": "9AAA9ED9-78F4-5021-86DC-D51C7511****",
  "Data": {
    "PageInfo": {
      "CurrentPage": 1,
      "PageSize": 10,
      "TotalCount": 100
    },
    "ResponseData": [
      {
        "Id": 123456789,
        "GmtCreate": "2021-01-06 16:37:29",
        "GmtModified": "2021-01-06 16:37:29",
        "Aliuid": 0,
        "RuleName": "waf_scan",
        "RuleDesc": "this rule is for waf scan",
        "RuleType": "customize",
        "ThreatLevel": "remind",
        "AlertType": "WEBSHELL",
        "AlertTypeMds": "${siem_rule_type_process_abnormal_command}",
        "LogType": "ALERT_ACTIVITY",
        "LogTypeMds": "${sas.cloudsiem.prod.alert_activity}",
        "LogSource": "cloud_siem_aegis_sas_alert",
        "LogSourceMds": "${sas.cloudsiem.prod.cloud_siem_aegis_sas_alert}",
        "RuleCondition": "[[{&quot;not&quot;:false,&quot;left&quot;:&quot;alert_name&quot;,&quot;operator&quot;:&quot;=&quot;,&quot;right&quot;:&quot;WEBSHELL&quot;}]]",
        "RuleGroup": "[&quot;asset_id&quot;]",
        "RuleThreshold": "{&quot;aggregateFunction&quot;:&quot;count&quot;,&quot;aggregateFunctionName&quot;:&quot;count&quot;,&quot;field&quot;:&quot;activity_name&quot;,&quot;operator&quot;:&quot;&lt;=&quot;,&quot;value&quot;:1}",
        "QueryCycle": "{&quot;time&quot;:&quot;1&quot;,&quot;unit&quot;:&quot;HOUR&quot;}",
        "EventTransferSwitch": 1,
        "EventTransferType": "allToSingle",
        "EventTransferExt": "{&quot;time&quot;:&quot;1&quot;,&quot;unit&quot;:&quot;MINUTE&quot;}",
        "Status": 0
      }
    ]
  }
}

Error codes

HTTP status codeError codeError message
501CloudSiem_Internal_ExceptionCloudSiem_Internal_Exception

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