更新时间:2025-07-04 GMT+08:00

查询剧本实例审计日志

功能介绍

查询剧本实例审计日志

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/instances/auditlogs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

workspace_id

String

工作空间ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Long

offset

limit

Long

limit

sort_key

String

sort_key

sort_dir

String

sort_dir. asc, desc

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

content-type

String

application/json;charset=UTF-8

表4 请求Body参数

参数

是否必选

参数类型

描述

instance_type

String

实例类型(AOP_WORKFLOW--流程, SCRIPT--脚本, PLAYBOOK--剧本)

action_id

String

流程ID

action_name

String

流程名称

instance_id

String

实例ID

parent_instance_id

String

父节点实例ID

log_level

String

日志级别

input

String

输入

output

String

输出

error_msg

String

错误信息

start_time

String

开始时间

end_time

String

结束时间

status

String

状态。(RUNNING--运行中、FINISHED--成功、FAILED--失败、RETRYING--重试中、TERMINATING--终止中、TERMINATED--已终止)

trigger_type

String

触发类型. TIMER--定时触发, EVENT--事件触发

响应参数

状态码:200

表5 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为:request_uuid-timestamp-hostname

表6 响应Body参数

参数

参数类型

描述

count

Integer

总条数

audit_logs

Array of AuditLogInfo objects

审计日志列表信息

表7 AuditLogInfo

参数

参数类型

描述

instance_type

String

实例类型(AOP_WORKFLOW--流程, SCRIPT--脚本, PLAYBOOK--剧本)

action_id

String

流程ID

action_name

String

流程名称

instance_id

String

实例ID

parent_instance_id

String

父节点实例ID

log_level

String

日志级别

input

String

输入

output

String

输出

error_msg

String

错误信息

start_time

String

开始时间

end_time

String

结束时间

status

String

状态。(RUNNING--运行中、FINISHED--成功、FAILED--失败、RETRYING--重试中、TERMINATING--终止中、TERMINATED--已终止)

trigger_type

String

触发类型. TIMER--定时触发, EVENT--事件触发

状态码:400

表8 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为:request_uuid-timestamp-hostname

表9 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误描述

请求示例

查询实例类型为APP, AOP_WORKFLOW, SCRIPT, PLAYBOOK, TASK, DEBUG,动作id为909494e3-558e-46b6-a9eb-07a8e18ca62f,动作名称为DisabledIp,实例id为909494e3-558e-46b6-a9eb-07a8e18ca62f,父实例id为909494e3-558e-46b6-a9eb-07a8e18ca62f,日志等级为DEBUG INFO WARN,输入为input,输出为output,错误信息为error_msg,开始时间2021-01-30 23:00:00,结束时间2021-01-31 23:00:00,状态为CREATED, RUNNING, FINISHED, RETRYING, TERMINATING, TERMINATED, FAILED,触发类型为DEBUG, TIMER, EVENT, MANUAL的剧本实例审计日志

{
  "instance_type" : "APP, AOP_WORKFLOW, SCRIPT, PLAYBOOK, TASK, DEBUG",
  "action_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "action_name" : "DisabledIp",
  "instance_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "parent_instance_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "log_level" : "DEBUG INFO WARN",
  "input" : "input",
  "output" : "output",
  "error_msg" : "error_msg",
  "start_time" : "2021-01-30T23:00:00Z",
  "end_time" : "2021-01-31T23:00:00Z",
  "status" : "CREATED, RUNNING, FINISHED, RETRYING, TERMINATING, TERMINATED, FAILED",
  "trigger_type" : "DEBUG, TIMER, EVENT, MANUAL"
}

响应示例

状态码:200

请求成功响应信息

{
  "count" : 41,
  "audit_logs" : [ {
    "instance_type" : "APP, AOP_WORKFLOW, SCRIPT, PLAYBOOK, TASK, DEBUG",
    "action_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "action_name" : "DisabledIp",
    "instance_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "parent_instance_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "log_level" : "DEBUG INFO WARN",
    "input" : "input",
    "output" : "output",
    "error_msg" : "error_msg",
    "start_time" : "2021-01-30T23:00:00Z",
    "end_time" : "2021-01-31T23:00:00Z",
    "status" : "CREATED, RUNNING, FINISHED, RETRYING, TERMINATING, TERMINATED, FAILED",
    "trigger_type" : "DEBUG, TIMER, EVENT, MANUAL"
  } ]
}

状态码

状态码

描述

200

请求成功响应信息

400

请求失败响应信息

错误码

请参见错误码