Updated on 2024-07-25 GMT+08:00

Creating a Playbook Version

Function

Creating a Playbook Version

Calling Method

For details, see Calling APIs.

URI

POST /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

Request Parameters

Table 2 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

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

description

No

String

Description.

Minimum: 0

Maximum: 1024

workspace_id

No

String

Workspace ID

Minimum: 0

Maximum: 2097152

playbook_id

No

String

Playbook ID.

Minimum: 32

Maximum: 64

actions

No

Array of ActionInfo objects

Associated workflows.

Array Length: 0 - 99

dataclass_id

No

String

Data class ID.

Minimum: 32

Maximum: 64

rule_enable

No

Boolean

Whether the filtering rule is enabled.

rule_id

No

String

Filtering rule ID.

Minimum: 0

Maximum: 64

trigger_type

No

String

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

Minimum: 0

Maximum: 64

dataobject_create

No

Boolean

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

dataobject_update

No

Boolean

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

dataobject_delete

No

Boolean

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

action_strategy

No

String

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

Minimum: 1

Maximum: 64

Table 4 ActionInfo

Parameter

Mandatory

Type

Description

id

No

String

Playbook workflow ID.

Minimum: 32

Maximum: 64

name

No

String

Workflow name.

Minimum: 0

Maximum: 1024

description

No

String

Description.

Minimum: 0

Maximum: 1024

action_type

No

String

Workflow type.

Minimum: 0

Maximum: 64

action_id

No

String

Workflow ID.

Minimum: 32

Maximum: 64

playbook_id

No

String

Playbook ID.

Minimum: 0

Maximum: 64

playbook_version_id

No

String

Playbook version ID.

Minimum: 0

Maximum: 64

project_id

No

String

Project ID.

Minimum: 0

Maximum: 64

Response Parameters

Status code: 200

Table 5 Response header parameters

Parameter

Type

Description

X-request-id

String

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

Table 6 Response body parameters

Parameter

Type

Description

code

String

Error code

Minimum: 1

Maximum: 32

message

String

Error message

Minimum: 1

Maximum: 32

data

PlaybookVersionInfo object

Playbook review details.

Table 7 PlaybookVersionInfo

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

Whether to enable the function. - true -- Enabled. - false -- Disabled

status

String

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

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

actions

Array of ActionInfo objects

Workflows associated with the playbook.

Array Length: 0 - 99

rule_enable

Boolean

Whether to enable the trigger condition filter.

rules

RuleInfo object

Playbook triggering specifications information.

dataclass_id

String

Data class ID.

Minimum: 0

Maximum: 64

trigger_type

String

How the playbook is triggered. 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

Version type (0 -- draft; 1 -- officially released)

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

Table 8 ActionInfo

Parameter

Type

Description

id

String

Playbook workflow ID.

Minimum: 32

Maximum: 64

name

String

Workflow name.

Minimum: 0

Maximum: 1024

description

String

Description.

Minimum: 0

Maximum: 1024

action_type

String

Workflow type.

Minimum: 0

Maximum: 64

action_id

String

Workflow ID.

Minimum: 32

Maximum: 64

playbook_id

String

Playbook ID.

Minimum: 0

Maximum: 64

playbook_version_id

String

Playbook version ID.

Minimum: 0

Maximum: 64

project_id

String

Project ID.

Minimum: 0

Maximum: 64

Table 9 RuleInfo

Parameter

Type

Description

id

String

Rule ID.

Minimum: 32

Maximum: 64

project_id

String

Project ID.

Minimum: 32

Maximum: 64

rule

String

Trigger rule.

Minimum: 0

Maximum: 128

Status code: 400

Table 10 Response header parameters

Parameter

Type

Description

X-request-id

String

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

Table 11 Response body parameters

Parameter

Type

Description

code

String

Error Code

Minimum: 0

Maximum: 64

message

String

Error Description

Minimum: 0

Maximum: 1024

Example Requests

Create a playbook version. Set the workspace ID to string, playbook ID to 909494e3-558e-46b6-a9eb-07a8e18ca62f, data class ID to 909494e3-558e-46b6-a9eb-07a8e18ca62f, and rule to Enabled.

{
  "description" : "This my XXXX",
  "workspace_id" : "string",
  "playbook_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "actions" : [ {
    "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "name" : "MyXXX",
    "description" : "This my XXXX",
    "action_type" : "Workflow",
    "action_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "playbook_id" : "string",
    "playbook_version_id" : "string",
    "project_id" : "string"
  } ],
  "dataclass_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "rule_enable" : true,
  "rule_id" : "4185bbd2-9d18-4362-92cb-46df0b24fe4e",
  "trigger_type" : "event",
  "dataobject_create" : true,
  "dataobject_update" : true,
  "dataobject_delete" : true,
  "action_strategy" : "sync"
}

Example Responses

Status code: 200

Response when the request is successful.

{
  "code" : 0,
  "message" : "Error message",
  "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",
    "actions" : [ {
      "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
      "name" : "MyXXX",
      "description" : "This my XXXX",
      "action_type" : "Workflow",
      "action_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
      "playbook_id" : "string",
      "playbook_version_id" : "string",
      "project_id" : "string"
    } ],
    "rule_enable" : true,
    "rules" : {
      "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
      "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
      "rule" : "909494e3-558e-46b6-a9eb-07a8e18ca62f"
    },
    "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.

Create a playbook version. Set the workspace ID to string, playbook ID to 909494e3-558e-46b6-a9eb-07a8e18ca62f, data class ID to 909494e3-558e-46b6-a9eb-07a8e18ca62f, and rule to Enabled.

 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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
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.*;

import java.util.List;
import java.util.ArrayList;

public class CreatePlaybookVersionSolution {

    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();
        CreatePlaybookVersionRequest request = new CreatePlaybookVersionRequest();
        CreatePlaybookVersionInfo body = new CreatePlaybookVersionInfo();
        List<ActionInfo> listbodyActions = new ArrayList<>();
        listbodyActions.add(
            new ActionInfo()
                .withId("909494e3-558e-46b6-a9eb-07a8e18ca62f")
                .withName("MyXXX")
                .withDescription("This my XXXX")
                .withActionType("Workflow")
                .withActionId("909494e3-558e-46b6-a9eb-07a8e18ca62f")
                .withPlaybookId("string")
                .withPlaybookVersionId("string")
                .withProjectId("string")
        );
        body.withActionStrategy("sync");
        body.withDataobjectDelete(true);
        body.withDataobjectUpdate(true);
        body.withDataobjectCreate(true);
        body.withTriggerType("event");
        body.withRuleId("4185bbd2-9d18-4362-92cb-46df0b24fe4e");
        body.withRuleEnable(true);
        body.withDataclassId("909494e3-558e-46b6-a9eb-07a8e18ca62f");
        body.withActions(listbodyActions);
        body.withPlaybookId("909494e3-558e-46b6-a9eb-07a8e18ca62f");
        body.withWorkspaceId("string");
        body.withDescription("This my XXXX");
        request.withBody(body);
        try {
            CreatePlaybookVersionResponse response = client.createPlaybookVersion(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());
        }
    }
}

Create a playbook version. Set the workspace ID to string, playbook ID to 909494e3-558e-46b6-a9eb-07a8e18ca62f, data class ID to 909494e3-558e-46b6-a9eb-07a8e18ca62f, and rule to Enabled.

 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
53
54
55
56
# 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 = CreatePlaybookVersionRequest()
        listActionsbody = [
            ActionInfo(
                id="909494e3-558e-46b6-a9eb-07a8e18ca62f",
                name="MyXXX",
                description="This my XXXX",
                action_type="Workflow",
                action_id="909494e3-558e-46b6-a9eb-07a8e18ca62f",
                playbook_id="string",
                playbook_version_id="string",
                project_id="string"
            )
        ]
        request.body = CreatePlaybookVersionInfo(
            action_strategy="sync",
            dataobject_delete=True,
            dataobject_update=True,
            dataobject_create=True,
            trigger_type="event",
            rule_id="4185bbd2-9d18-4362-92cb-46df0b24fe4e",
            rule_enable=True,
            dataclass_id="909494e3-558e-46b6-a9eb-07a8e18ca62f",
            actions=listActionsbody,
            playbook_id="909494e3-558e-46b6-a9eb-07a8e18ca62f",
            workspace_id="string",
            description="This my XXXX"
        )
        response = client.create_playbook_version(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Create a playbook version. Set the workspace ID to string, playbook ID to 909494e3-558e-46b6-a9eb-07a8e18ca62f, data class ID to 909494e3-558e-46b6-a9eb-07a8e18ca62f, and rule to Enabled.

 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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
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.CreatePlaybookVersionRequest{}
	idActions:= "909494e3-558e-46b6-a9eb-07a8e18ca62f"
	nameActions:= "MyXXX"
	descriptionActions:= "This my XXXX"
	actionTypeActions:= "Workflow"
	actionIdActions:= "909494e3-558e-46b6-a9eb-07a8e18ca62f"
	playbookIdActions:= "string"
	playbookVersionIdActions:= "string"
	projectIdActions:= "string"
	var listActionsbody = []model.ActionInfo{
        {
            Id: &idActions,
            Name: &nameActions,
            Description: &descriptionActions,
            ActionType: &actionTypeActions,
            ActionId: &actionIdActions,
            PlaybookId: &playbookIdActions,
            PlaybookVersionId: &playbookVersionIdActions,
            ProjectId: &projectIdActions,
        },
    }
	actionStrategyCreatePlaybookVersionInfo:= "sync"
	dataobjectDeleteCreatePlaybookVersionInfo:= true
	dataobjectUpdateCreatePlaybookVersionInfo:= true
	dataobjectCreateCreatePlaybookVersionInfo:= true
	triggerTypeCreatePlaybookVersionInfo:= "event"
	ruleIdCreatePlaybookVersionInfo:= "4185bbd2-9d18-4362-92cb-46df0b24fe4e"
	ruleEnableCreatePlaybookVersionInfo:= true
	dataclassIdCreatePlaybookVersionInfo:= "909494e3-558e-46b6-a9eb-07a8e18ca62f"
	playbookIdCreatePlaybookVersionInfo:= "909494e3-558e-46b6-a9eb-07a8e18ca62f"
	workspaceIdCreatePlaybookVersionInfo:= "string"
	descriptionCreatePlaybookVersionInfo:= "This my XXXX"
	request.Body = &model.CreatePlaybookVersionInfo{
		ActionStrategy: &actionStrategyCreatePlaybookVersionInfo,
		DataobjectDelete: &dataobjectDeleteCreatePlaybookVersionInfo,
		DataobjectUpdate: &dataobjectUpdateCreatePlaybookVersionInfo,
		DataobjectCreate: &dataobjectCreateCreatePlaybookVersionInfo,
		TriggerType: &triggerTypeCreatePlaybookVersionInfo,
		RuleId: &ruleIdCreatePlaybookVersionInfo,
		RuleEnable: &ruleEnableCreatePlaybookVersionInfo,
		DataclassId: &dataclassIdCreatePlaybookVersionInfo,
		Actions: &listActionsbody,
		PlaybookId: &playbookIdCreatePlaybookVersionInfo,
		WorkspaceId: &workspaceIdCreatePlaybookVersionInfo,
		Description: &descriptionCreatePlaybookVersionInfo,
	}
	response, err := client.CreatePlaybookVersion(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.