本產品（
云安全中心（響應編排）/2022-07-28）的OpenAPI采用RPC簽名風格，簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK，開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（78410016550），在專家指導下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節請參見獲取AccessKey。
劇本編排
| API | 標題 | API概述 |
|---|---|---|
| VerifyPythonFile | 校驗python代碼片段 | 校驗Python代碼片段的語法是否正確。 |
| VerifyPlaybook | 校驗劇本配置 | 校驗劇本的配置是否正確，編排的邏輯是否合理。 |
| TriggerSophonPlaybook | 觸發劇本或響應命令 | 用于觸發運行劇本或響應命令。 |
| TriggerPlaybook | 觸發劇本 | 用于觸發已啟用的自定義劇本或預定義劇本。 |
| RunPython3Script | 運行python3腳本 | 用于提交一段python3的代碼片段并執行，只能用于數據處理。 |
| RevertPlaybookRelease | 回滾劇本版本 | 用于回滾劇本到指定的版本，同時可以指定回滾時是否發布該版本。 |
| RenamePlaybookNode | 重命令節點命稱 | 用戶在編排劇本過程中，使用該接口可重命名劇本中某一節點的名稱，對該節點的引用路徑也會隨之改變。 |
| QueryTreeData | 獲取所有劇本的列表 | 用于一次性獲取所有的劇本列表。 |
| PublishPlaybook | 發布劇本 | 用于把劇本配置發布線上，發布后，劇本會以新的邏輯來運行。 |
| ModifyPlaybookInstanceStatus | 修改劇本的啟停狀態 | 用于修改劇本的啟動與停止狀態。 |
| ModifyPlaybookInputOutput | 修改劇本的出入參數 | 用于修改劇本的輸入參數與輸出參數。 |
| ModifyPlaybook | 編輯劇本 | 用于修改劇本的配置信息。 |
| ModifyComponentAsset | 修改組件資產 | 當一個組件需要配置資產時，該接口用戶修改組件的資產信息。 |
| DescriberPython3ScriptLogs | 獲取pyhton腳本運行日志 | 在提交pyhton腳本的任務后，通過返回的requestUuid來獲取運行日志。 |
| DescribeSophonCommands | 獲取處置命令 | 用于獲取處置實體的命令。 |
| DescribeSoarTaskAndActions | 獲取劇本的組件執行記錄 | 用于獲取劇本的一次運行過程中，組件的執行記錄列表。 |
| DescribeSoarRecords | 獲取劇本執行記錄 | 用于獲取劇本的執行記錄列表。 |
| DescribeSoarRecordInOutput | 獲取組件運行時數據 | 當用戶執行劇本任務后，通過該接口可獲取組件動作的輸入數據與輸出數據。 |
| DescribeSoarRecordActionOutputList | 獲取組件執行的輸出數據列表 | 用于獲取劇本任務中，某一組件執行動作時，輸出的數據列表。 |
| DescribePopApi | 獲取OpenAPI接口詳情 | 用于獲取OpenAPI的接口詳情。 |
| DescribePlaybooks | 獲取劇本列表 | 用于獲取劇本列表。 |
| DescribePlaybookReleases | 獲取劇本發布的版本列表 | 用于獲取劇本發布的線上版本的信息列表。 |
| DescribePlaybookNumberMetrics | 獲取響應編排統計信息 | 用于獲取響應編排產品的統計信息，包含劇本數量、啟用數量等內容。 |
| DescribePlaybookNodesOutput | 獲取組件輸出的歷史數據 | 用于獲取組件輸出的歷史數據。 |
| DescribePlaybookMetrics | 獲取劇本的元信息 | 獲取某一劇本的元信息，包括名字、描述、運行次數、失敗率等。 |
| DescribePlaybookInputOutput | 獲取劇本的出入參數配置 | 用于獲取劇本的輸入參數與輸出參數的配置信息。 |
| DescribePlaybook | 獲取劇本配置 | 用于獲取劇本的xml配置信息。 |
| DescribeNodeUsedInfos | 獲取劇本節點的引用信息 | 用于獲取劇本中，某一節點正在被哪些節點引用。 |
| DescribeNodeParamTags | 獲取組件的推薦輸入 | 用于編排劇本時，組件輸入的可引用路徑。 |
| DescribeLatestRecordSchema | 獲取最新執行記錄結構信息 | 用于根據劇本最新一次的執行記錄，動態生成劇本各節點的輸出結構信息。 |
| DescribeField | 獲取全局配置信息 | 用于獲取產品全局的，通用的配置信息。 |
| DescribeExecutePlaybooks | 獲取可執行的劇本列表 | 用于配置自動響應計劃時，獲取可執行的劇本列表。 |
| DescribeEnumItems | 獲取枚舉信息 | 用于獲取產品需要的一些枚舉信息。 |
| DescribeDistinctReleases | 獲取去重的版本列表 | 獲取去重后的劇本發布的版本信息列表。 |
| DescribeComponentPlaybook | 獲取預定義組件列表 | 用于獲取用戶可以使用的預定義組件列表。 |
| DescribeComponentList | 獲取組件列表 | 用于獲取用戶可使用的普通組件的列表。 |
| DescribeComponentAssets | 獲取組件的資產列表 | 用于獲取某一組件的資產信息列表。 |
| DescribeComponentAssetForm | 獲取組件資產元信息 | 用于獲取組件的資產元信息，即資產信息是由哪些字段組成的。 |
| DeletePlaybook | 刪除劇本 | 用于刪除指定的自定義劇本。 |
| DeleteComponentAsset | 刪除資產信息 | 用于刪除組件配置的資產信息。 |
| DebugPlaybook | 調試劇本 | 用于調試運行劇本。 |
| ComparePlaybooks | 比較劇本版本信息 | 用于比較發布的兩個版本的劇本配置信息。 |
| BatchModifyInstanceStatus | 批量修改劇本狀態 | 用于批量修改劇本的啟用與停止狀態。 |
| CreatePlaybook | 創建劇本 | 用于創建一個初始化的劇本。 |
| DescribeComponentsJs | 獲取組件的JS文件 | 用于獲取組件的JS文件，組件會以返回的JS文件來進行頁面的渲染。 |
處置任務
| API | 標題 | API概述 |
|---|---|---|
| DescribeProcessTaskCount | 通過實體UUID查詢關聯的處置任務數 | 通過實體UUID查詢關聯的處置任務數。 |
| DescribeProcessTasks | 獲取處置任務列表 | 用戶在使用響應編排的功能進行事件處置時，處置中心會生成相應的處置任務，該接口用于獲取處置任務的列表信息。 |
| TriggerProcessTask | 執行處置動作 | 用戶在使用響應編排的功能進行事件處置時，處置中心會生成相應的處置任務，該接口用于對生成的處置任務執行后續的解除封禁、重試封禁、解除隔離等動作。 |