Querying the Playbook List
Function
This API is used to query the playbook list.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
workspace_id |
Yes |
String |
Workspace ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
search_txt |
No |
String |
Search keyword. |
enabled |
No |
Boolean |
Whether to enable this feature. |
offset |
Yes |
Integer |
Pagination query parameter. This parameter specifies the start position of the query result. The value starts from 0. |
limit |
Yes |
Integer |
The maximum number of records can be returned on each page for a pagination query. The value starts from 1. |
description |
No |
String |
Playbook description. |
dataclass_name |
No |
String |
Data class name. |
name |
No |
String |
Playbook name. |
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 the user token. |
content-type |
Yes |
String |
application/json;charset=UTF-8 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
Request ID. Format: request_uuid-timestamp-hostname. |
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code. |
message |
String |
Response message information. |
total |
Integer |
Total records. |
size |
Integer |
Records on each page. |
page |
Integer |
Current page number. |
data |
Array of PlaybookInfo objects |
Playbook list information. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Playbook ID. |
name |
String |
Playbook name. |
description |
String |
Description. |
create_time |
String |
Time the playbook was created. |
update_time |
String |
Time the playbook was updated. |
project_id |
String |
Project ID. |
version_id |
String |
Playbook version ID. |
enabled |
Boolean |
Whether to enable this feature. |
workspace_id |
String |
Workspace ID. |
approve_role |
String |
Reviewer role. |
user_role |
String |
User role. |
edit_role |
String |
Role of the editor. |
owner_id |
String |
Owner ID. |
version |
String |
Version No. |
dataclass_name |
String |
Data class name. |
dataclass_id |
String |
Data class ID. |
unaudited_version_id |
String |
ID of the playbook version to be reviewed. |
reject_version_id |
String |
ID of the rejected playbook version. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
Request ID. 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 parameters for a successful playbook list query.
{ "code" : 0, "message" : null, "total" : 41, "page" : 10, "data" : [ { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "MyXXX", "description" : "This my XXXX", "create_time" : "2021-01-30T23:00:00Z+0800", "update_time" : "2021-01-30T23:00:00Z+0800", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "version_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "enabled" : true, "workspace_id" : "string", "approve_role" : "approve", "user_role" : "string", "edit_role" : "editor", "owner_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "version" : "v1.1.1", "dataclass_name" : "string", "dataclass_id" : "string", "unaudited_version_id" : "string", "reject_version_id" : "string" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Response parameters for a successful playbook list query. |
400 |
Response parameters for failed requests. |
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot