Playbook Running Monitoring
Function
Playbook Running Monitoring
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/{playbook_id}/monitor
Parameter | Mandatory | Type | Description |
|---|---|---|---|
project_id | Yes | String | Project ID. |
workspace_id | Yes | String | Workspace ID |
playbook_id | Yes | String | Playbook ID. |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
start_time | Yes | String | Start time.The format is ISO 8601- YYYY-MM-DDTHH:mm:ss.ms+Time zone. For example, 2021-01-30T23:00:00Z+0800. Time zone is where the playbook instances occured. If this parameter cannot be parsed, the default time zone GMT+8 is used. |
version_query_type | Yes | String | Playbook version type. The options are ALL:all,VALID:valid,DELETED:deleted. |
end_time | Yes | String | End time.The format is ISO 8601- YYYY-MM-DDTHH:mm:ss.ms+Time zone. For example, 2021-01-30T23:00:00Z+0800. Time zone is where the playbook instances occured. If this parameter cannot be parsed, the default time zone GMT+8 is used. |
Request 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
Parameter | Type | Description |
|---|---|---|
X-request-id | String | Request ID, in the format request_uuid-timestamp-hostname. |
Parameter | Type | Description |
|---|---|---|
code | String | Error code |
message | String | Error Message |
data | Playbook monitoring details. |
Parameter | Type | Description |
|---|---|---|
total_instance_run_num | Integer | Total running times. |
schedule_instance_run_num | Integer | Scheduled executions. |
event_instance_run_num | Integer | Time-triggered executions. |
average_run_time | Number | Average duration. |
min_run_time_instance | Workflow with the shortest running duration. | |
max_run_time_instance | Workflow with the longest running duration. | |
total_instance_num | Integer | Total number of playbook instances. |
success_instance_num | Integer | Number of successful instances. |
fail_instance_num | Integer | Failed instances. |
terminate_instance_num | Integer | Number of terminated instances. |
running_instance_num | Integer | Number of running instances. |
Parameter | Type | Description |
|---|---|---|
playbook_instance_id | String | Playbook instance ID. |
playbook_instance_name | String | Playbook instance name. |
playbook_instance_run_time | Number | Playbook instance running time. |
Status code: 400
Parameter | Type | Description |
|---|---|---|
X-request-id | String | Request ID, in the format request_uuid-timestamp-hostname. |
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.
{
"code" : "00000000",
"message" : "",
"data" : {
"total_instance_run_num" : "Unknown Type: in",
"schedule_instance_run_num" : 99999999,
"event_instance_run_num" : 99999999,
"average_run_time" : 9999999999,
"min_run_time_instance" : {
"playbook_instance_id" : "string",
"playbook_instance_name" : "string",
"playbook_instance_run_time" : 9999999999
},
"max_run_time_instance" : {
"playbook_instance_id" : "string",
"playbook_instance_name" : "string",
"playbook_instance_run_time" : 9999999999
},
"total_instance_num" : 99999999,
"success_instance_num" : 99999999,
"fail_instance_num" : 99999999,
"terminate_instance_num" : 99999999,
"running_instance_num" : 99999999
}
} Status Codes
Status Code | Description |
|---|---|
200 | Response when the request is successful. |
400 | Response when the request failed. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
