Updated on 2024-06-18 GMT+08:00

Viewing Monitored Playbook Instances

Scenario

After a playbook is executed, a playbook instance is generated in the playbook instance management list for monitoring. Each record in the instance monitoring list is an instance. You can view the historical instance task list and the statuses of historical instance tasks.

View instance monitoring information.

Limitations and Constraints

The maximum number of retries within a day for a single workspace of a single account is as follows:

  • Manual retry: 100. After a retry, the playbook cannot be retried until the current execution is complete.
  • API retry: 100. After a retry, the playbook cannot be retried until the current execution is complete.

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner of the page and choose Security & Compliance > SecMaster.
  3. In the navigation pane on the left, choose Workspaces > Management. In the workspace list, click the name of the target workspace.

    Figure 1 Workspace management page

  4. In the navigation pane on the left, choose Security Orchestration > Playbooks. On the displayed page, click the Instance Management tab.

    Figure 2 Instance Management page

  5. In the instance management list, view the instance name, playbook/instance name, and trigger method. For details about the parameters, see Table 1.

    Figure 3 Instances
    • You can view the total number of instances below the instance list. You can view a maximum of 10,000 instance records page by page. To view more than 10,000 records, optimize the filter criteria.
    • An instance can be stored for a maximum of 180 days.
    • To view details about an instance, click the instance name. On the displayed page, you can view the instance workflow, workflow nodes, start time, and end time.
    Table 1 Parameters in the instance list

    Parameter

    Description

    Instance Name

    Name of the instance generated by the system.

    Playbook Name

    Name of the playbook corresponding to the instance.

    Data Class

    Operation object of a playbook

    Trigger Method

    Triggering mode of an instance

    • Timer Trigger
    • Event Trigger

    Status

    Status of an instance

    • Succeeded: The playbook instance is successfully executed.
    • Failed: The playbook instance fails to be executed. You can click Retry in the Operation column to execute the playbook again.
    • Running: The playbook instance is running. You can click Terminate in the Operation column to terminate the playbook.
    • Retrying: The playbook instance is being retried.
    • Terminating: The playbook instance is being terminated.
    • Stopped: The playbook instance has been terminated.

    Context

    Context information of an instance

    Instance Creation Time

    Time when an instance is created.

    Instance Ended

    Time when an instance ends.

    Operation

    You can terminate or retry an instance.

Related Operations

  • To stop a running instance, click Terminate in the Operation column of the target instance. After an instance is terminated, no operations are supported.
  • To start a failed instance, click Retry in the Operation column.

    You can retry instances up to 100 times a day in a single workspace. After a retry, the playbook cannot be retried until the current execution is complete.