文档首页/ 安全云脑 SecMaster/ API参考（吉隆坡区域）/ API/ 剧本管理/ 剧本运行监控
更新时间：2025-07-04 GMT+08:00
在线调试
CLI示例
查看PDF
分享

剧本运行监控

功能介绍

剧本运行监控

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/{playbook_id}/monitor

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

workspace_id

是

String

工作空间ID

playbook_id

是

String

剧本ID
表2 Query参数

参数

是否必选

参数类型

描述

start_time

是

String

开始时间。格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。例如：2021-01-30T23:00:00Z+0800。时区信息为剧本实例产生的时区，无法解析时区的时间，默认时区填东八区。

version_query_type

是

String

统计剧本版本类型（ALL:全部，VALID:有效的，DELETED:已删除）

end_time

是

String

结束时间。格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。例如：2021-01-30T23:00:00Z+0800。时区信息为剧本实例产生的时区，无法解析时区的时间，默认时区填东八区。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

content-type

是

String

application/json;charset=UTF-8

响应参数

状态码：200

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为：request_uuid-timestamp-hostname
表5 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误信息

data

PlaybookInstanceMonitorDetail object

剧本运行监控详情
表6 PlaybookInstanceMonitorDetail

参数

参数类型

描述

total_instance_run_num

Integer

运行总次数

schedule_instance_run_num

Integer

定时触发执行次数

event_instance_run_num

Integer

时间触发执行次数

average_run_time

Number

平均运行时间

min_run_time_instance

PlaybookInstanceRunStatistics object

最短运行时间流程实例信息

max_run_time_instance

PlaybookInstanceRunStatistics object

最长运行时间流程实例信息

total_instance_num

Integer

剧本实例总数

success_instance_num

Integer

运行成功实例数量

fail_instance_num

Integer

运行失败实例数量

terminate_instance_num

Integer

运行终止实例数量

running_instance_num

Integer

运行中实例数量
表7 PlaybookInstanceRunStatistics

参数

参数类型

描述

playbook_instance_id

String

剧本实例ID

playbook_instance_name

String

剧本实例名称

playbook_instance_run_time

Number

剧本实例运行时间

状态码：400

表8 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为：request_uuid-timestamp-hostname
表9 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误描述

请求示例

无

响应示例

状态码：200

请求成功响应信息

{
  "code" : "00000000",
  "message" : "",
  "data" : {
    "total_instance_run_num" : "Unknown Type: in",
    "schedule_instance_run_num" : 99999999,
    "event_instance_run_num" : 99999999,
    "average_run_time" : 9999999999,
    "min_run_time_instance" : {
      "playbook_instance_id" : "string",
      "playbook_instance_name" : "string",
      "playbook_instance_run_time" : 9999999999
    },
    "max_run_time_instance" : {
      "playbook_instance_id" : "string",
      "playbook_instance_name" : "string",
      "playbook_instance_run_time" : 9999999999
    },
    "total_instance_num" : 99999999,
    "success_instance_num" : 99999999,
    "fail_instance_num" : 99999999,
    "terminate_instance_num" : 99999999,
    "running_instance_num" : 99999999
  }
}

状态码

状态码

描述

200

请求成功响应信息

400

请求失败响应信息

错误码

请参见错误码。

父主题： 剧本管理