DescribeSoarPlaybookTaskDetail - 查询剧本任务详情

获取任务中心策略对应剧本的执行结果。

接口说明

仅云安全中心的企业版和旗舰版支持该 API 调用,其他版本不支持。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:DescribeSoarPlaybookTaskDetailget
*全部资源
*

请求参数

名称类型必填描述示例值
RecordIdlong

创建策略任务时传入的漏洞 ID。

说明 调用 DescribeVulList 接口可以获取该参数。
14
PlaybookIdlong

剧本 ID。

说明 调用 DescribePlaybooks 接口可以获取该参数。
123
RequestUuidstring

剧本任务执行的 UUID。

说明 调用 DescribeSoarRecords 接口可以获取该参数。
a15e37da-abe0-4d87-acd2-024e875a****

返回参数

名称类型描述示例值
object

返回内容。

RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

0B48AB3C-84FC-424D-A01D-B9270EF4****
TaskDetailobject

任务详情。

LogInfostring

任务的日志信息。

{"status":1, "errMsg":"paramError"}
ProcessInfostring

策略对应的流程信息。

{"edges":[{"level":0,"removeFlag":0,"source":1,"target":8}]}
Paramsstring

调用剧本的参数。

params1
TaskNamestring

任务名称。

task1

示例

正常返回示例

JSON格式

{
  "RequestId": "0B48AB3C-84FC-424D-A01D-B9270EF4****",
  "TaskDetail": {
    "LogInfo": {
      "status": 1,
      "errMsg": "paramError"
    },
    "ProcessInfo": {
      "edges": [
        {
          "level": 0,
          "removeFlag": 0,
          "source": 1,
          "target": 8
        }
      ]
    },
    "Params": "params1",
    "TaskName": "task1"
  }
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

访问错误中心查看更多错误码。