Querying Playbook Rule Details
Function
Querying Playbook Rule Details
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/versions/{version_id}/rules/{rule_id}
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. |
| workspace_id | Yes | String | Workspace ID |
| version_id | Yes | String | version Id value |
| rule_id | Yes | String | version Id value |
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 | RuleInfo object | Playbook triggering specifications information. |
| Parameter | Type | Description |
|---|---|---|
| id | String | Rule ID. |
| project_id | String | Project ID. |
| rule | String | Trigger rule. |
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" : 0,
"message" : "Error message",
"data" : {
"id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"rule" : "909494e3-558e-46b6-a9eb-07a8e18ca62f"
}
} 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.
