Help Center/ SecMaster/ API Reference/ API/ Playbook Version Management/ Querying the Playbook Version List
Updated on 2024-07-25 GMT+08:00

Querying the Playbook Version List

Function

Querying the Playbook Version List

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/{playbook_id}/versions

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Minimum: 32

Maximum: 36

workspace_id

Yes

String

Workspace ID

Minimum: 32

Maximum: 36

playbook_id

Yes

String

Playbook ID.

Minimum: 32

Maximum: 64

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

status

No

String

Playbook version status. Options are Editing, APPROVING, UNPASSED, and PUBLISHED

Minimum: 0

Maximum: 64

enabled

No

Integer

enabled/disabled

Minimum: 0

Maximum: 1

version_type

No

Integer

Version type. The options are as follows 0 is draft version; 1 is official version.

Minimum: 0

Maximum: 10

offset

No

Integer

Indicates the page number. Start position of the query result. The value starts from 0.

Minimum: 0

Maximum: 999999

limit

No

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

Request Parameters

Table 3 Request header 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

Table 4 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID, in the format request_uuid-timestamp-hostname.

Table 5 Response body parameters

Parameter

Type

Description

code

String

Error code

Minimum: 1

Maximum: 32

message

String

Error Message

Minimum: 1

Maximum: 32

size

Integer

Records on each page.

Minimum: 0

Maximum: 9999

page

Integer

Current page.

Minimum: 0

Maximum: 100

total

Integer

Total

Minimum: 0

Maximum: 99999

data

Array of PlaybookVersionListEntity objects

Playbook version list.

Array Length: 0 - 100000000

Table 6 PlaybookVersionListEntity

Parameter

Type

Description

id

String

Playbook version ID.

Minimum: 32

Maximum: 64

description

String

Description.

Minimum: 0

Maximum: 1024

create_time

String

Creation time.

Minimum: 0

Maximum: 64

update_time

String

Update time.

Minimum: 0

Maximum: 64

project_id

String

Project ID.

Minimum: 32

Maximum: 64

creator_id

String

Creator ID.

Minimum: 32

Maximum: 64

modifier_id

String

ID of the user who updated the information.

Minimum: 32

Maximum: 64

playbook_id

String

Playbook ID.

Minimum: 32

Maximum: 64

version

String

Version No.

Minimum: 32

Maximum: 64

enabled

Boolean

Activated

status

String

Status. (EDITING -- editing, APPROVING -- reviewing, UNPASSED -- not approved, Published -- approved)

Minimum: 0

Maximum: 64

action_strategy

String

Execution policy. Currently, only asynchronous concurrent execution is supported. The corresponding value is ASYNC.

Minimum: 0

Maximum: 64

rule_enable

Boolean

Whether the filtering rule is enabled.

dataclass_id

String

Data class ID.

Minimum: 0

Maximum: 64

trigger_type

String

Triggering mode. The options are as follows - EVENT -- event; TIMER -- scheduled.

Minimum: 0

Maximum: 64

dataobject_create

Boolean

Whether to trigger a playbook when a data object is created.

dataobject_update

Boolean

Whether to trigger a playbook when a data object is updated.

dataobject_delete

Boolean

Whether to trigger a playbook when a data object is deleted.

version_type

Integer

Edition

Minimum: 0

Maximum: 1

rule_id

String

Filtering rule ID.

Minimum: 0

Maximum: 64

dataclass_name

String

Data class name.

Minimum: 0

Maximum: 64

approve_name

String

Reviewer.

Minimum: 0

Maximum: 64

Status code: 400

Table 7 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID, in the format request_uuid-timestamp-hostname.

Table 8 Response body parameters

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 when the request is successful.

{
  "code" : 0,
  "message" : "Error message",
  "size" : 3,
  "page" : 10,
  "total" : 41,
  "data" : [ {
    "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "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",
    "creator_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "modifier_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "playbook_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "version" : "v1.1.1",
    "enabled" : true,
    "status" : "editing",
    "action_strategy" : "sync",
    "rule_enable" : true,
    "dataclass_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "trigger_type" : "event",
    "dataobject_create" : true,
    "dataobject_update" : true,
    "dataobject_delete" : true,
    "version_type" : 1,
    "rule_id" : "string",
    "dataclass_name" : "string",
    "approve_name" : "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
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 ListPlaybookVersionsSolution {

    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();
        ListPlaybookVersionsRequest request = new ListPlaybookVersionsRequest();
        request.withStatus("<status>");
        request.withEnabled(<enabled>);
        request.withVersionType(<version_type>);
        request.withOffset(<offset>);
        request.withLimit(<limit>);
        try {
            ListPlaybookVersionsResponse response = client.listPlaybookVersions(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
# 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 = ListPlaybookVersionsRequest()
        request.status = "<status>"
        request.enabled = <enabled>
        request.version_type = <version_type>
        request.offset = <offset>
        request.limit = <limit>
        response = client.list_playbook_versions(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
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.ListPlaybookVersionsRequest{}
	statusRequest:= "<status>"
	request.Status = &statusRequest
	enabledRequest:= int32(<enabled>)
	request.Enabled = &enabledRequest
	versionTypeRequest:= int32(<version_type>)
	request.VersionType = &versionTypeRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	response, err := client.ListPlaybookVersions(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 when the request is successful.

400

Response when the request failed.

Error Codes

See Error Codes.