API概览_云安全中心(Security Center)-阿里云帮助中心

本产品（sophonsoar/2022-07-28）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。

在使用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	执行处置动作	用户在使用响应编排的功能进行事件处置时，处置中心会生成相应的处置任务，该接口用于对生成的处置任务执行后续的解除封禁、重试封禁、解除隔离等动作。

其他

API	标题	API概述
DescribeProcessStatistics	获取处置任务的统计信息	获取统计信息。
CopyPlaybook	复制剧本	剧本复制。
DescribeOpenApiList	查询OPENAPI列表	获取产品的接口列表。
ConvertPlaybook	转换剧本流程图配置格式	转换剧本流程图配置格式，由xml转为x6。用于兼容历史数据，早期版本中配置剧本使用的xml格式，之后改为了x6格式。
DescribeOpenApiInfo	查询OPENAPI信息	获取产品接口的详情。
DescribeGroupProductions	获取阿里云产品的分组列表	获取阿里云产品的分组列表信息。
DescribeNotifyTemplateList	查询模版列表	查询通知消息模版列表。
RunNotifyComponentWithEmail	通知组件-测试邮件发送	执行通知组件-email发送消息。
RunNotifyComponentWithMessageCenter	通知组件-测试消息中心的消息发送	执行通知组件-消息中心发送消息。
RunNotifyComponentWithWebhook	通知组件-测试webhook发送	执行通知组件-webhook发送消息。
DescribeVendorApiList	查询多云厂商的OpenApi列表	查询云厂商OpenApi列表。