查询剧本拓扑关系
功能介绍
查询剧本拓扑关系
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/instances/{instance_id}/topology
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
workspace_id |
是 |
String |
工作空间ID |
|
instance_id |
是 |
String |
剧本实例ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
content-type |
是 |
String |
application/json;charset=UTF-8 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为：request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
总数 |
|
action_instances |
Array of ActionInstanceInfo objects |
流程实例列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
action |
ActionInfo object |
剧本流程动作信息 |
|
instance_log |
AuditLogInfo object |
剧本实例审计日志信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
剧本流程动作ID |
|
name |
String |
流程动作名称 |
|
description |
String |
描述 |
|
action_type |
String |
流程动作类型 |
|
action_id |
String |
流程ID |
|
playbook_id |
String |
剧本ID |
|
playbook_version_id |
String |
剧本版本ID |
|
project_id |
String |
项目ID |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为：request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
message |
String |
错误描述 |
请求示例
无
响应示例
状态码：200
请求成功响应信息
{
"count" : 41,
"action_instances" : [ {
"action" : {
"id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"name" : "MyXXX",
"description" : "This my XXXX",
"action_type" : "Workflow",
"action_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"playbook_id" : "string",
"playbook_version_id" : "string",
"project_id" : "string"
},
"instance_log" : {
"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 |
请求失败响应信息 |
错误码
请参见错误码。
