创建剧本版本
功能介绍
创建剧本版本
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/{playbook_id}/versions
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID 最小长度:32 最大长度:36 |
workspace_id |
是 |
String |
工作空间ID 最小长度:32 最大长度:36 |
playbook_id |
是 |
String |
剧本ID 最小长度:32 最大长度:64 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:2097152 |
content-type |
是 |
String |
application/json;charset=UTF-8 缺省值:application/json;charset=UTF-8 最小长度:1 最大长度:64 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
description |
否 |
String |
描述 最小长度:0 最大长度:1024 |
workspace_id |
否 |
String |
工作空间ID 最小长度:0 最大长度:2097152 |
playbook_id |
否 |
String |
剧本ID 最小长度:32 最大长度:64 |
actions |
否 |
Array of ActionInfo objects |
关联流程列表 数组长度:0 - 99 |
dataclass_id |
否 |
String |
数据类ID 最小长度:32 最大长度:64 |
rule_enable |
否 |
Boolean |
过滤规则是否启用 |
rule_id |
否 |
String |
过滤规则ID 最小长度:0 最大长度:64 |
trigger_type |
否 |
String |
触发方式. EVENT--事件触发, TIMER--定时触发 最小长度:0 最大长度:64 |
dataobject_create |
否 |
Boolean |
标识数据对象是否创建时触发剧本 |
dataobject_update |
否 |
Boolean |
标识数据对象是否更新时触发剧本 |
dataobject_delete |
否 |
Boolean |
标识数据对象是否删除时触发剧本 |
action_strategy |
否 |
String |
执行策略. 目前仅支持异步并发执行,对应值为ASYNC 最小长度:1 最大长度:64 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
String |
剧本流程动作ID 最小长度:32 最大长度:64 |
name |
否 |
String |
流程动作名称 最小长度:0 最大长度:1024 |
description |
否 |
String |
描述 最小长度:0 最大长度:1024 |
action_type |
否 |
String |
流程动作类型 最小长度:0 最大长度:64 |
action_id |
否 |
String |
流程ID 最小长度:32 最大长度:64 |
playbook_id |
否 |
String |
剧本ID 最小长度:0 最大长度:64 |
playbook_version_id |
否 |
String |
剧本版本ID 最小长度:0 最大长度:64 |
project_id |
否 |
String |
项目ID 最小长度:0 最大长度:64 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname |
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
错误码 最小长度:1 最大长度:32 |
message |
String |
Error message 最小长度:1 最大长度:32 |
data |
PlaybookVersionInfo object |
剧本版本详情信息 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
剧本版本ID 最小长度:32 最大长度:64 |
description |
String |
描述 最小长度:0 最大长度:1024 |
create_time |
String |
创建时间 最小长度:0 最大长度:64 |
update_time |
String |
更新时间 最小长度:0 最大长度:64 |
project_id |
String |
项目ID 最小长度:32 最大长度:64 |
creator_id |
String |
创建者ID 最小长度:32 最大长度:64 |
modifier_id |
String |
修改者ID 最小长度:32 最大长度:64 |
playbook_id |
String |
剧本ID 最小长度:32 最大长度:64 |
version |
String |
版本号 最小长度:32 最大长度:64 |
enabled |
Boolean |
是否启用。(true--已启用,false-未启用) |
status |
String |
剧本版本状态,编辑中:EDITING 审核中:APPROVING 不通过:UNPASSED 已发布:PUBLISHED 最小长度:0 最大长度:64 |
action_strategy |
String |
执行策略. 目前仅支持异步并发执行,对应值为ASYNC 最小长度:0 最大长度:64 |
actions |
Array of ActionInfo objects |
剧本关联流程列表信息 数组长度:0 - 99 |
rule_enable |
Boolean |
是否启用触发条件过滤器 |
rules |
RuleInfo object |
剧本触发规格信息 |
dataclass_id |
String |
数据类ID 最小长度:0 最大长度:64 |
trigger_type |
String |
剧本触发方式(EVENT--事件触发,TIMER--定时触发) 最小长度:0 最大长度:64 |
dataobject_create |
Boolean |
标识数据对象是否创建时触发剧本 |
dataobject_update |
Boolean |
标识数据对象是否更新时触发剧本 |
dataobject_delete |
Boolean |
标识数据对象是否删除时触发剧本 |
version_type |
Integer |
版本类型(0--草稿版本,1--正式版本) 最小值:0 最大值:1 |
rule_id |
String |
过滤规则ID 最小长度:0 最大长度:64 |
dataclass_name |
String |
数据类名称 最小长度:0 最大长度:64 |
approve_name |
String |
审核者 最小长度:0 最大长度:64 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
剧本流程动作ID 最小长度:32 最大长度:64 |
name |
String |
流程动作名称 最小长度:0 最大长度:1024 |
description |
String |
描述 最小长度:0 最大长度:1024 |
action_type |
String |
流程动作类型 最小长度:0 最大长度:64 |
action_id |
String |
流程ID 最小长度:32 最大长度:64 |
playbook_id |
String |
剧本ID 最小长度:0 最大长度:64 |
playbook_version_id |
String |
剧本版本ID 最小长度:0 最大长度:64 |
project_id |
String |
项目ID 最小长度:0 最大长度:64 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
规则ID 最小长度:32 最大长度:64 |
project_id |
String |
项目ID 最小长度:32 最大长度:64 |
rule |
String |
触发规则 最小长度:0 最大长度:128 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname |
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
错误码 最小长度:0 最大长度:64 |
message |
String |
错误描述 最小长度:0 最大长度:1024 |
请求示例
创建一个剧本版本,剧本版本所属工作空间ID为string,剧本ID为909494e3-558e-46b6-a9eb-07a8e18ca62f,数据类ID为909494e3-558e-46b6-a9eb-07a8e18ca62f,规则为启用。
{ "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" }
响应示例
状态码: 200
请求成功响应信息
{ "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代码示例
SDK代码示例如下。
创建一个剧本版本,剧本版本所属工作空间ID为string,剧本ID为909494e3-558e-46b6-a9eb-07a8e18ca62f,数据类ID为909494e3-558e-46b6-a9eb-07a8e18ca62f,规则为启用。
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()); } } } |
创建一个剧本版本,剧本版本所属工作空间ID为string,剧本ID为909494e3-558e-46b6-a9eb-07a8e18ca62f,数据类ID为909494e3-558e-46b6-a9eb-07a8e18ca62f,规则为启用。
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) |
创建一个剧本版本,剧本版本所属工作空间ID为string,剧本ID为909494e3-558e-46b6-a9eb-07a8e18ca62f,数据类ID为909494e3-558e-46b6-a9eb-07a8e18ca62f,规则为启用。
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) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求成功响应信息 |
400 |
请求失败响应信息 |
错误码
请参见错误码。