Querying the Playbook Instance List

Updated on 2024-12-25 GMT+08:00

View PDF

Function

Calling Method

For details, see Calling APIs.

URI

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

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
status	No	String	Playbook instance status.(RUNNING--Running, FINISHED--Successful, Failed--Failed, Retrying--Retrying, Terminated--Terminated)
name	No	String	Instance name.
playbook_name	No	String	Playbook name.
dataclass_name	No	String	Data class name.
dataobject_name	No	String	Data object name.
trigger_type	No	String	Triggering type. TIMER indicates scheduled triggering, and EVENT indicates event triggering.
from_date	No	String	Start time.
to_date	No	String	Query end time
limit	Yes	Integer	The maximum number of records can be returned on each page for a pagination query. The value starts from 1.
offset	Yes	Integer	Indicates the page number. Start position of the query result. The value starts from 0.

Request Parameters

**Table 3** 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 4** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID, in the format request_uuid-timestamp-hostname.

**Table 5** Response body parameters
Parameter	Type	Description
count	Integer	Total
instances	Array of PlaybookInstanceInfo objects	Playbook instance list information.

**Table 6** PlaybookInstanceInfo
Parameter	Type	Description
id	String	Playbook instance ID.
name	String	Playbook instance name.
project_id	String	Project ID.
playbook	PlaybookInfoRef object	Playbook information.
dataclass	DataclassInfoRef object	Data Information
dataobject	DataobjectInfo object	Data object details.
status	String	Playbook instance status.(RUNNING--Running, FINISHED--Successful, Failed--Failed, Retrying--Retrying, Terminated--Terminated)
trigger_type	String	Triggering type. TIMER indicates scheduled triggering, and EVENT indicates event triggering.
start_time	String	Creation time.
end_time	String	Update time.

**Table 7** PlaybookInfoRef
Parameter	Type	Description
id	String	Playbook ID.
version_id	String	Playbook version ID.
name	String	Name.
version	String	Version.

**Table 8** DataclassInfoRef
Parameter	Type	Description
id	String	Data class ID.
name	String	Data class name.

**Table 9** DataobjectInfo
Parameter	Type	Description
id	String	ID
create_time	String	Creation time.
update_time	String	Update time.
project_id	String	Project ID.
dataclass_id	String	Data class ID.
name	String	Name.
content	String	Data content.

Status code: 400

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

**Table 11** 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,
  "instances" : [ {
    "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "name" : "MyXXX",
    "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "playbook" : {
      "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
      "version_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
      "name" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
      "version" : "v1.1.1"
    },
    "dataclass" : {
      "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
      "name" : "909494e3-558e-46b6-a9eb-07a8e18ca62f"
    },
    "dataobject" : {
      "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
      "name" : "909494e3-558e-46b6-a9eb-07a8e18ca62f"
    },
    "status" : "TERMINATED",
    "trigger_type" : "string",
    "start_time" : "2021-01-30T23:00:00Z+0800",
    "end_time" : "2021-01-30T23:00:00Z+0800"
  } ]
}