Querying Playbook Instance Details
Function
Show playbook instance
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/instances/{instance_id}
Parameter | Mandatory | Type | Description |
|---|---|---|---|
project_id | Yes | String | Project ID. |
workspace_id | Yes | String | Workspace ID |
instance_id | Yes | String | instance _id |
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 |
|---|---|---|
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. |
Parameter | Type | Description |
|---|---|---|
id | String | Playbook ID. |
version_id | String | Playbook version ID. |
name | String | Name. |
version | String | Version. |
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
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
Instance Informations
{
"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"
} Status Codes
Status Code | Description |
|---|---|
200 | Instance Informations |
400 | Error response |
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.
