調用DescribeSoarRecords API擷取劇本執行記錄-Security Center-阿里雲

用於擷取劇本的執行記錄列表。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-sas:DescribeSoarRecords

get

*Playbook

acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}

無

請求參數

名稱	類型	必填	描述	樣本值
PlaybookUuid	string	否	劇本的 UUID。說明調用 DescribePlaybooks 介面可以擷取該參數。	8f55e76d-b5d5-4720-9cd7-xxxxx
TaskflowMd5	string	否	劇本配置的 MD5 值。	be0a4ef084dd174abe478df52xxxxx
StartMillis	integer	否	任務啟動並執行開始時間，格式：13 位的時間戳記。	1683526284584
EndMillis	integer	否	任務啟動並執行結束時間，格式：13 位的時間戳記。	1683772744953
Lang	string	否	佈建要求和接收訊息的語言類型，預設為 zh。取值： zh：中文 en：英文	zh
TriggerUser	string	否	執行劇本任務的阿里雲賬戶 ID。	127xxxx4392
TaskStatus	string	否	任務的運行狀態，取值： success：成功任務。 failed：失敗任務。 inprogress：運行中任務。	inprogress
PageNumber	integer	否	設定從返回結果的第幾頁開始顯示查詢結果。預設值為 1，表示從第 1 頁開始顯示。	1
PageSize	integer	否	指定分頁查詢時，每頁顯示的資料最大條數。每頁預設顯示的資料條數為 20 條，PageSize 參數值為空白時，將預設返回 10 條資料。說明建議 PageSize 取值不要為空白。	10
RequestUuid	string	否	劇本任務執行的 UUID。說明調用 DescribeSoarRecords 介面可以擷取該參數。	6d412cfa-0905-4567-8a83-xxxxxx
TriggerType	string	否	任務觸發類型，取值： stream：流式觸發。 debug：調試觸發。 manual：人工觸發。 timer：定時觸發。 SubInvoke：子流程觸發。 siem：siem 產品觸發。	debug
QueryValue	string	否	劇本輸入參數。	input
CompletedBeginTime	integer	否	任務完成的開始時間，格式：13 位的時間戳記。	1755676363777
CompletedEndTime	integer	否	任務完成的結束時間，格式：13 位的時間戳記。	1683526284584

返回參數

名稱	類型	描述	樣本值
	object	返回資訊。
RequestId	string	本次調用請求的 ID，是由阿里雲為該請求產生的唯一識別碼，可用於排查和定位問題。	601C2DAC-6A67-5237-BEE8-5BF1CEE9*****
SoarExecuteRecords	array<object>	執行記錄結果集。
	array<object>	執行記錄詳情。
TriggerType	string	劇本任務的類型，取值： debug：表示調試任務。 manual：表示手動任務。 siem：表示事件或警示觸發的任務。	debug
TaskName	string	劇本任務的名稱，同劇本的 UUID。	82848ebc-eaff-4791-acd4-xxxxx
StartTime	integer	任務啟動並執行開始時間，格式：13 位的時間戳記。	1675823338433
EndTime	integer	組件啟動並執行結束時間，格式：13 位的時間戳記。	1686294686000
Status	string	劇本執行的任務狀態，取值為： success：表示執行成功。 fail：表示執行失敗。 running：表示正在運行	success
RequestUuid	string	劇本任務的請求 ID，每次任務啟動並執行唯一 ID。	ba1ec480-aa90-4bb6-a1a7-9e311ae*****
TriggerUser	string	執行劇本任務的阿里雲賬戶 ID。	127xxxx4392
ErrorMsg	string	劇本任務的錯誤資訊，任務成功時，該欄位為空白。	stime not match
RawEventReq	string	劇本任務的請求參數。	{ "input1": "xx.xx.xx.xx", "input2": "7d" }
TaskflowMd5	string	劇本配置的 MD5 值。	dea65a3db87fb9bd84bbxxxxx
OutputList	array<object>	劇本的輸出資訊。
	object	JSONArray
Content	string	輸出內容。	{"msg":"process has been killed","code":"KillSuccess","status":"success"}
NodeName	string	輸出資訊的節點名稱。	TriggerPlaybook_4
ActionUuid	string	節點 UUID。	4e78d665-2366-4485-8fbc-048a8d41a2c3-25****
Page	object	頁面顯示的資訊。
TotalCount	integer	查詢到的資訊總數量。	22
PageNumber	integer	分頁查詢時，當前頁的頁碼。	1
PageSize	integer	分頁查詢時，每頁顯示的條目數量。	10

樣本

正常返回樣本

JSON格式

{
  "RequestId": "601C2DAC-6A67-5237-BEE8-5BF1CEE9*****",
  "SoarExecuteRecords": [
    {
      "TriggerType": "debug",
      "TaskName": "82848ebc-eaff-4791-acd4-xxxxx",
      "StartTime": 1675823338433,
      "EndTime": 1686294686000,
      "Status": "success",
      "RequestUuid": "ba1ec480-aa90-4bb6-a1a7-9e311ae*****",
      "TriggerUser": "127xxxx4392",
      "ErrorMsg": "stime not match",
      "RawEventReq": "{\n    \"input1\": \"xx.xx.xx.xx\",\n    \"input2\": \"7d\"\n}",
      "TaskflowMd5": "dea65a3db87fb9bd84bbxxxxx",
      "OutputList": [
        {
          "Content": " {\"msg\":\"process has been killed\",\"code\":\"KillSuccess\",\"status\":\"success\"}",
          "NodeName": "TriggerPlaybook_4",
          "ActionUuid": "4e78d665-2366-4485-8fbc-048a8d41a2c3-25****"
        }
      ]
    }
  ],
  "Page": {
    "TotalCount": 22,
    "PageNumber": 1,
    "PageSize": 10
  }
}

錯誤碼

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

變更歷史

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