Querying the Playbook List
Function
Querying 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. Minimum: 32 Maximum: 36 |
workspace_id |
Yes |
String |
Workspace ID Minimum: 32 Maximum: 36 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
search_txt |
No |
String |
Keyword Minimum: 32 Maximum: 36 |
enabled |
No |
Boolean |
Whether to enable. |
offset |
Yes |
Integer |
Indicates the page number. Start position of the query result. The value starts from 0. Minimum: 0 Maximum: 999999 Default: 0 |
limit |
Yes |
Integer |
The maximum number of records can be returned on each page for a pagination query. The value starts from 1. Minimum: 1 Maximum: 999999 |
description |
No |
String |
Playbook description. Minimum: 0 Maximum: 64 |
dataclass_name |
No |
String |
Data class name. Minimum: 0 Maximum: 64 |
name |
No |
String |
Playbook name. Minimum: 0 Maximum: 64 |
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. Minimum: 1 Maximum: 2097152 |
content-type |
Yes |
String |
application/json;charset=UTF-8 Default: application/json;charset=UTF-8 Minimum: 1 Maximum: 64 |
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 Minimum: 1 Maximum: 32 |
message |
String |
Response message information Minimum: 1 Maximum: 32 |
total |
Integer |
Total records. Minimum: 0 Maximum: 99999 |
size |
Integer |
Records on each page. Minimum: 0 Maximum: 9999 |
page |
Integer |
Current page. Minimum: 0 Maximum: 100 |
data |
Array of PlaybookInfo objects |
Playbook list information. Array Length: 0 - 100000000 |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Playbook ID. Minimum: 32 Maximum: 64 |
name |
String |
Playbook name. Minimum: 0 Maximum: 1024 |
description |
String |
Provides supplementary information about the resource. Minimum: 0 Maximum: 1024 |
create_time |
String |
Playbook creation time. Minimum: 0 Maximum: 64 |
update_time |
String |
Playbook update time. Minimum: 0 Maximum: 64 |
project_id |
String |
Project ID. Minimum: 32 Maximum: 64 |
version_id |
String |
Playbook version ID. Minimum: 32 Maximum: 64 |
enabled |
Boolean |
Whether to enable. |
workspace_id |
String |
Workspace ID Minimum: 32 Maximum: 64 |
approve_role |
String |
Reviewer role. Minimum: 0 Maximum: 64 |
user_role |
String |
Role Minimum: 0 Maximum: 64 |
edit_role |
String |
Edit Role for Account Minimum: 0 Maximum: 64 |
owner_id |
String |
ID Minimum: 32 Maximum: 64 |
version |
String |
Version No. Minimum: 32 Maximum: 64 |
dataclass_name |
String |
Data class name. Minimum: 0 Maximum: 64 |
dataclass_id |
String |
Data class ID. Minimum: 1 Maximum: 64 |
unaudited_version_id |
String |
ID of the playbook version to be reviewed. Minimum: 1 Maximum: 64 |
reject_version_id |
String |
ID of the rejected playbook version. Minimum: 1 Maximum: 64 |
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 Minimum: 0 Maximum: 64 |
message |
String |
Error Description Minimum: 0 Maximum: 1024 |
Example Requests
None
Example Responses
Status code: 200
Response parameters for 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" } ] }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.secmaster.v2.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v2.*; import com.huaweicloud.sdk.secmaster.v2.model.*; public class ListPlaybooksSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); SecMasterClient client = SecMasterClient.newBuilder() .withCredential(auth) .withRegion(SecMasterRegion.valueOf("<YOUR REGION>")) .build(); ListPlaybooksRequest request = new ListPlaybooksRequest(); request.withSearchTxt("<search_txt>"); request.withEnabled(<enabled>); request.withOffset(<offset>); request.withLimit(<limit>); request.withDescription("<description>"); request.withDataclassName("<dataclass_name>"); request.withName("<name>"); try { ListPlaybooksResponse response = client.listPlaybooks(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksecmaster.v2.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListPlaybooksRequest() request.search_txt = "<search_txt>" request.enabled = <Enabled> request.offset = <offset> request.limit = <limit> request.description = "<description>" request.dataclass_name = "<dataclass_name>" request.name = "<name>" response = client.list_playbooks(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := secmaster.NewSecMasterClient( secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListPlaybooksRequest{} searchTxtRequest:= "<search_txt>" request.SearchTxt = &searchTxtRequest enabledRequest:= <enabled> request.Enabled = &enabledRequest request.Offset = int32(<offset>) request.Limit = int32(<limit>) descriptionRequest:= "<description>" request.Description = &descriptionRequest dataclassNameRequest:= "<dataclass_name>" request.DataclassName = &dataclassNameRequest nameRequest:= "<name>" request.Name = &nameRequest response, err := client.ListPlaybooks(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Response parameters for 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