Querying the Playbook Topology

Function

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/instances/{instance_id}/topology

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
workspace_id	Yes	String	Workspace ID
instance_id	Yes	String	Playbook instance ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.
content-type	Yes	String	application/json;charset=UTF-8

Response Parameters

Status code: 200

**Table 3** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID, in the format request_uuid-timestamp-hostname.

**Table 4** Response body parameters
Parameter	Type	Description
count	Integer	Total
action_instances	Array of ActionInstanceInfo objects	Incident instance list.

**Table 5** ActionInstanceInfo
Parameter	Type	Description
action	ActionInfo object	Playbook workflows.
instance_log	AuditLogInfo object	Playbook instance review information.

**Table 6** ActionInfo
Parameter	Type	Description
id	String	Playbook workflow ID.
name	String	Workflow name.
description	String	Description.
action_type	String	Workflow type.
action_id	String	Workflow ID.
playbook_id	String	Playbook ID.
playbook_version_id	String	Playbook version ID.
project_id	String	Project ID.

**Table 7** AuditLogInfo
Parameter	Type	Description
instance_type	String	Instance type (AOP_WORKFLOW for workflows, SCRIPT for scripts, and PLAYBOOK for playbooks).
action_id	String	Workflow ID.
action_name	String	Workflow name.
instance_id	String	Instance ID.
parent_instance_id	String	Instance ID of the parent node.
log_level	String	Log Level
input	String	Input.
output	String	Output.
error_msg	String	Error Message
start_time	String	Start time.
end_time	String	End time.
status	String	Status. (RUNNING, FINISHED, FAILED, RETRYING, and TERMINATED)
trigger_type	String	Triggering type. TIMER indicates scheduled triggering, and EVENT indicates event triggering.

Status code: 400

**Table 8** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID, in the format request_uuid-timestamp-hostname.

**Table 9** Response body parameters
Parameter	Type	Description
code	String	Error Code
message	String	Error Description

Example Requests

None

Example Responses

Status code: 200

Response when the request is successful.

{
  "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"
    }
  } ]
}