Creating a Playbook Version
Function
This API is used to create a playbook version.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/{playbook_id}/versions
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
workspace_id |
Yes |
String |
Workspace ID. |
playbook_id |
Yes |
String |
Playbook ID. |
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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
description |
No |
String |
Description. |
workspace_id |
No |
String |
Workspace ID. |
playbook_id |
No |
String |
Playbook ID. |
actions |
No |
Array of ActionInfo objects |
The list of the associated workflows. |
dataclass_id |
No |
String |
Data class ID. |
rule_enable |
No |
Boolean |
Whether the filter rule is enabled. |
rule_id |
No |
String |
Filter rule ID. |
trigger_type |
No |
String |
Trigger method. EVENT: Triggered by incidents; TIMER: Triggered as scheduled. |
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
String |
Playbook workflow ID. |
name |
No |
String |
Workflow name. |
description |
No |
String |
Description. |
action_type |
No |
String |
Workflow type. |
action_id |
No |
String |
Workflow ID. |
playbook_id |
No |
String |
Playbook ID. |
playbook_version_id |
No |
String |
Playbook version ID. |
project_id |
No |
String |
Project ID. |
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 |
Error message |
data |
PlaybookVersionInfo object |
Playbook version details. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Playbook version ID. |
description |
String |
Description. |
create_time |
String |
Creation time. |
update_time |
String |
Update time. |
project_id |
String |
Project ID. |
creator_id |
String |
Creator ID. |
modifier_id |
String |
ID of the editor. |
playbook_id |
String |
Playbook ID. |
version |
String |
Version No. |
enabled |
Boolean |
Enable or not. true: Enabled false: Disabled |
status |
String |
Playbook version status. Options: Editing, APPROVING, UNPASSED, and PUBLISHED |
action_strategy |
String |
Execution policy. Currently, only asynchronous concurrent execution is supported. The corresponding value is ASYNC. |
actions |
Array of ActionInfo objects |
The list of workflows associated with the playbook. |
rule_enable |
Boolean |
Whether to enable the trigger condition filter. |
rules |
RuleInfo object |
Playbook trigger information. |
dataclass_id |
String |
Data class ID. |
trigger_type |
String |
How the playbook is triggered. Options: EVENT and TIMER |
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: Released). |
rule_id |
String |
Filter rule ID. |
dataclass_name |
String |
Data class name. |
approve_name |
String |
Reviewer. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Playbook workflow ID. |
name |
String |
Workflow name. |
description |
String |
Description. |
action_type |
String |
Workflow type. |
action_id |
String |
Workflow ID. |
playbook_id |
String |
Playbook ID. |
playbook_version_id |
String |
Playbook version ID. |
project_id |
String |
Project ID. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Rule ID. |
project_id |
String |
Project ID. |
rule |
String |
Trigger rules. |
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
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 to a successful request.
{
"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.
Java
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 |
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");
String projectId = "{project_id}";
ICredential auth = new BasicCredentials()
.withProjectId(projectId)
.withAk(ak)
.withSk(sk);
SecMasterClient client = SecMasterClient.newBuilder()
.withCredential(auth)
.withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
.build();
CreatePlaybookVersionRequest request = new CreatePlaybookVersionRequest();
request.withWorkspaceId("{workspace_id}");
request.withPlaybookId("{playbook_id}");
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());
}
}
}
|
Python
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 |
# 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"]
projectId = "{project_id}"
credentials = BasicCredentials(ak, sk, projectId)
client = SecMasterClient.new_builder() \
.with_credentials(credentials) \
.with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = CreatePlaybookVersionRequest()
request.workspace_id = "{workspace_id}"
request.playbook_id = "{playbook_id}"
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)
|
Go
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 81 82 83 84 |
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")
projectId := "{project_id}"
auth := basic.NewCredentialsBuilder().
WithAk(ak).
WithSk(sk).
WithProjectId(projectId).
Build()
client := secmaster.NewSecMasterClient(
secmaster.SecMasterClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.CreatePlaybookVersionRequest{}
request.WorkspaceId = "{workspace_id}"
request.PlaybookId = "{playbook_id}"
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)
}
}
|
More
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 to a successful request. |
400 |
Response message 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