通過DescribePlaybooks API檢索SOAR劇本 - Security Center

用於擷取劇本列表。

介面說明

請確保在使用該介面前，已充分瞭解響應編排產品的收費方式和價格。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-sas:DescribePlaybooks

get

*Playbook

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

無

請求參數

名稱	類型	必填	描述	樣本值
Active	integer	否	劇本的啟用狀態，取值： 1：表示劇本已啟用。 0：表示劇本未啟用。	1
OwnType	string	否	劇本的類型，取值： preset：預定義劇本。 user：自訂劇本。	user
StartMillis	integer	否	查詢的開始時間，格式：13 位的時間戳記。	1683526277415
EndMillis	integer	否	查詢的結束時間，格式：13 位的時間戳記。	1683858064361
PlaybookUuid	string	否	劇本的 UUID。說明調用 CreatePlaybook 介面可以擷取該參數。	8baa6cff-319e-4ede-97bc-1xxxxxx
Name	string	否	劇本的名稱。	demo_playbook
Lang	string	否	指定請求和接收訊息的語言類型，預設為 zh。取值： zh：中文。 en：英文。	zh
PageSize	integer	否	指定分頁查詢時，每頁顯示的資料最大條數。每頁預設顯示的資料條數為 20 條，PageSize 參數值為空白時，將預設返回 10 條資料。說明建議 PageSize 取值不要為空白。	10
PageNumber	integer	否	設定從返回結果的第幾頁開始顯示查詢結果。預設值為 1，表示從第 1 頁開始顯示。	1
Sort	integer	否	排序依據，預設為 1。取值： 1：上次修改時間。 2：最近執行時間。	1
Order	string	否	排序邏輯，預設為 desc，取值： desc ：降序排序。 asc：升序排序。	desc
ParamTypes	string	否	劇本觸發方式，預設為查詢所有。取值： template-incident：安全事件。 template-ip： IP 實體。 template-file：檔案實體。 template-process：進程實體。 template-alert：安全警示。 template-domain：網域名稱實體。 template-container：容器實體。 template-host：主機實體。 template-custom：自訂。	template-alert
PlaybookUuids	string	否	劇本的 UUID 的集合，最多支援 100 個，多個用逗號隔開。	8baa6cff-319e-4ede-97bc-1xxxxxx,8rrt6cff-319e-4ede-97bc-1xxxxxx

返回參數

名稱	類型	描述	樣本值
	object	返回資訊。
RequestId	string	本次調用請求的 ID，是由阿里雲為該請求產生的唯一識別碼，可用於排查和定位問題。	138B5AB7-**-5814-87A3-E3E**F207E
Playbooks	array<object>	劇本的列表。
	object	劇本的資訊。
DisplayName	string	劇本的展示名稱。	demo_playbook
PlaybookUuid	string	劇本的 UUID。	bb5a8640-a14f-44ef-8376-cxxxxx
OwnType	string	劇本的類型，取值： preset：預定義劇本。 user：自訂劇本。	user
Active	integer	劇本的狀態標識。取值： 1：表示啟動劇本。 0：表示停止劇本。	1
LastRuntime	integer	劇本的最後執行時間，格式：13 位的時間戳記。	1683526277415
GmtCreate	integer	劇本建立時間，格式：13 位的時間戳記。	1683526277415
GmtModified	string	劇本修改時間。	1681396398000
ParamType	string	劇本觸發方式，預設為查詢所有。取值： template-incident：安全事件。 template-ip：IP 實體。 template-file：檔案實體。 template-process：進程實體。 template-alert：安全警示。 template-domain：網域名稱實體。 template-container：容器實體。 template-host：主機實體。	template-alert
Description	string	劇本的描述資訊。	aegis_kill_process
TenantId	string	劇本所屬的使用者識別碼。	123456
Page	object	分頁查詢資訊。
TotalCount	integer	查詢到的資訊總數量。	100
PageNumber	integer	分頁查詢時，當前頁的頁碼。	1
PageSize	integer	分頁查詢時，每頁顯示的條目數量。	10

樣本

正常返回樣本

JSON格式

{
  "RequestId": "138B5AB7-****-5814-87A3-E3E****F207E",
  "Playbooks": [
    {
      "DisplayName": "demo_playbook",
      "PlaybookUuid": "bb5a8640-a14f-44ef-8376-cxxxxx",
      "OwnType": "user",
      "Active": 1,
      "LastRuntime": 1683526277415,
      "GmtCreate": 1683526277415,
      "GmtModified": "1681396398000",
      "ParamType": "template-alert",
      "Description": "aegis_kill_process",
      "TenantId": "123456"
    }
  ],
  "Page": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10
  }
}

錯誤碼

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

變更歷史

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