調用ListCloudSiemCustomizeRules API查詢自訂規則列表-Security Center-阿里雲

擷取自訂規則列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-sas:ListCloudSiemCustomizeRules

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Id	string	否	自訂規則 ID。	10223
StartTime	integer	否	查詢開始時間，單位毫秒。	1577808000000
EndTime	integer	否	查詢結束時間，單位毫秒。	1577808000000
ThreatLevel	array	否	威脅等級，JSON 數組格式。取值： serious：高危 suspicious：中危 remind：低危	["serious","suspicious","remind"]
	string	否	威脅等級，JSON 數組格式。取值： serious：高危 suspicious：中危 remind：低危	["remind","serious"]
AlertType	string	否	警示類型。	scan
RuleName	string	否	規則名稱，僅支援字母、數字、底線、點。	waf_scan
RuleType	string	否	規則類型。取值： predefine：預定義 customize：自訂	customize
Status	integer	否	規則狀態。取值： 0：初始狀態 10：類比資料測試 15：業務資料測試中 20：業務資料測試結束 100：規則上線	0
OrderField	string	否	規則列表排欄欄位。取值： GmtModified：基於修改時間排序 Id：基於規則 id 排序（預設）	Id
Order	string	否	事件列表排列方向。取值： desc：降序排列 asc：升序排列。	desc
CurrentPage	integer	是	列表當前頁號，大於等於 1。	1
PageSize	integer	是	列表每頁條數，最大不超過 100。	10
RoleType	integer	否	檢視類型。 0：當前阿里雲帳號視圖。 1：企業下所有帳號的視圖。	1
RoleFor	integer	否	管理員切換成其他成員視角的使用者識別碼。	113091674488****
RegionId	string	否	威脅分析的資料管理中心所在地。您需要根據資產所在地區，選擇管理中心所在地。取值： cn-hangzhou：資產屬於中國內地與中國香港 ap-southeast-1：資產屬于海外地區	cn-hangzhou

返回參數

名稱	類型	描述	樣本值
	object	PageResponse<List>
Success	boolean	請求是否成功。取值： true：成功 false：失敗	true
Code	integer	請求狀態代碼。	200
Message	string	請求返回訊息。	success
RequestId	string	請求 ID。	9AAA9ED9-78F4-5021-86DC-D51C7511****
Data	object	請求傳回值。	123456
PageInfo	object	分頁記錄。
CurrentPage	integer	列表當前頁號。	1
PageSize	integer	每頁返回記錄數。	10
TotalCount	integer	記錄總數。	100
ResponseData	array<object>	詳細資料。
	object
Id	integer	自訂規則 ID。	123456789
GmtCreate	string	自訂規則建立時間。	2021-01-06 16:37:29
GmtModified	string	自訂規則最後更新時間。	2021-01-06 16:37:29
Aliuid	integer	SIEM 主帳號 ID。	127608589417****
RuleName	string	規則名稱。	waf_scan
RuleDesc	string	規則描述。	this rule is for waf scan
RuleType	string	規則類型。取值： predefine：預定義 customize：自訂	customize
ThreatLevel	string	威脅等級。取值： serious：高危 suspicious：中危 remind：低危	remind
AlertType	string	威脅類型。	WEBSHELL
AlertTypeMds	string	威脅類型美杜莎 Code。	${siem_rule_type_process_abnormal_command}
LogType	string	規則對應的日誌類型。	ALERT_ACTIVITY
LogTypeMds	string	規則對應的日誌類型美杜莎 Code。	${sas.cloudsiem.prod.alert_activity}
LogSource	string	規則對應的日誌源。	cloud_siem_aegis_sas_alert
LogSourceMds	string	規則對應的日誌源美杜莎 Code。	${sas.cloudsiem.prod.cloud_siem_aegis_sas_alert}
RuleCondition	string	規則查詢條件，JSON 數組格式（需要對 HTML 逸出字元進行反向轉義）。	[[{"not":false,"left":"alert_name","operator":"=","right":"WEBSHELL"}]]
RuleGroup	string	日誌彙總欄位，JSON 數組格式（需要對 HTML 逸出字元進行反向轉義）。	["asset_id"]
RuleThreshold	string	規則閾值配置 json（需要對 html 逸出字元進行反向轉義）。	{"aggregateFunction":"count","aggregateFunctionName":"count","field":"activity_name","operator":"<=","value":1}
QueryCycle	string	規則視窗長度（需要對 html 逸出字元進行反向轉義）。	{"time":"1","unit":"HOUR"}
AttCk	string	警示附加欄位 attck。	T1595.002 Vulnerability Scanning
EventTransferSwitch	integer	警示是否轉換事件開關。取值： 0：不轉換 1：轉換	1
EventTransferType	string	事件產生方式。取值： default：預設內建方式 singleToSingle：每個警示產生一個事件 allToSingle：周期內警示產生一個事件	allToSingle
EventTransferExt	string	事件產生擴充資訊。當 eventTransferType 值為 allToSingle，該欄位有值，表示警示彙總視窗的周期長度以及周期單位（需要對 html 逸出字元進行反向轉義）。	{"time":"1","unit":"MINUTE"}
Status	integer	規則狀態。取值： 0：初始狀態 10：類比資料測試 15：業務資料測試中 20：業務資料測試結束 100：規則上線	0
DataType	integer	檢視類型。 0：當前阿里雲帳號視圖。 1：企業下所有帳號的視圖。	1

樣本

正常返回樣本

JSON格式

{
  "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": "[[{"not":false,"left":"alert_name","operator":"=","right":"WEBSHELL"}]]",
        "RuleGroup": "["asset_id"]",
        "RuleThreshold": "{"aggregateFunction":"count","aggregateFunctionName":"count","field":"activity_name","operator":"<=","value":1}",
        "QueryCycle": "{"time":"1","unit":"HOUR"}",
        "AttCk": "T1595.002 Vulnerability Scanning",
        "EventTransferSwitch": 1,
        "EventTransferType": "allToSingle",
        "EventTransferExt": "{"time":"1","unit":"MINUTE"}",
        "Status": 0,
        "DataType": 1
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
500	InternalError	The request processing has failed due to some unknown error.	服務發生某些未知錯誤，請稍後再試

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。