更新时间:2024-12-13 GMT+08:00
分享

更新剧本版本

功能介绍

更新剧本版本

调用方法

请参见如何调用API

URI

PUT /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/versions/{version_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

workspace_id

String

工作空间ID

version_id

String

剧本版本ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

content-type

String

application/json;charset=UTF-8

表3 请求Body参数

参数

是否必选

参数类型

描述

description

String

描述

workspace_id

String

工作空间ID

playbook_id

String

剧本ID

dataclass_id

String

数据类ID

rule_enable

Boolean

是否启用触发条件过滤器

enabled

Boolean

是否激活。(false:未激活, true:已激活)

status

String

状态(APPROVING:审核中,EDITING-编辑中,UNPASSED-审核未通过,PUBLISHED-已发布)

rule_id

String

规则ID

trigger_type

String

触发方式. EVENT--事件触发, TIMER--定时触发

dataobject_create

Boolean

数据对象是否创建时触发剧本

dataobject_update

Boolean

数据对象是否更新时触发剧本

dataobject_delete

Boolean

数据对象是否删除时触发剧本

action_strategy

String

执行策略. 目前仅支持异步并发执行,对应值为ASYNC

响应参数

状态码: 200

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为:request_uuid-timestamp-hostname

表5 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

Error message

data

PlaybookVersionInfo object

剧本版本详情信息

表6 PlaybookVersionInfo

参数

参数类型

描述

id

String

剧本版本ID

description

String

描述

create_time

String

创建时间

update_time

String

更新时间

project_id

String

项目ID

creator_id

String

创建者ID

modifier_id

String

修改者ID

playbook_id

String

剧本ID

version

String

版本号

enabled

Boolean

是否启用。(true--已启用,false-未启用)

status

String

剧本版本状态,编辑中:EDITING 审核中:APPROVING 不通过:UNPASSED 已发布:PUBLISHED

action_strategy

String

执行策略. 目前仅支持异步并发执行,对应值为ASYNC

actions

Array of ActionInfo objects

剧本关联流程列表信息

rule_enable

Boolean

是否启用触发条件过滤器

rules

RuleInfo object

剧本触发规格信息

dataclass_id

String

数据类ID

trigger_type

String

剧本触发方式(EVENT--事件触发,TIMER--定时触发)

dataobject_create

Boolean

标识数据对象是否创建时触发剧本

dataobject_update

Boolean

标识数据对象是否更新时触发剧本

dataobject_delete

Boolean

标识数据对象是否删除时触发剧本

version_type

Integer

版本类型(0--草稿版本,1--正式版本)

rule_id

String

过滤规则ID

dataclass_name

String

数据类名称

approve_name

String

审核者

表7 ActionInfo

参数

参数类型

描述

id

String

剧本流程动作ID

name

String

流程动作名称

description

String

描述

action_type

String

流程动作类型

action_id

String

流程ID

playbook_id

String

剧本ID

playbook_version_id

String

剧本版本ID

project_id

String

项目ID

表8 RuleInfo

参数

参数类型

描述

id

String

规则ID

project_id

String

项目ID

rule

String

触发规则

状态码: 400

表9 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为:request_uuid-timestamp-hostname

表10 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误描述

请求示例

更新一个剧本版本,剧本版本所属工作空间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",
  "dataclass_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "rule_enable" : true,
  "enabled" : true,
  "status" : "UNPASSED",
  "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代码示例如下。

Java

更新一个剧本版本,剧本版本所属工作空间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
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 UpdatePlaybookVersionSolution {

    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();
        UpdatePlaybookVersionRequest request = new UpdatePlaybookVersionRequest();
        request.withWorkspaceId("{workspace_id}");
        request.withVersionId("{version_id}");
        ModifyPlaybookVersionInfo body = new ModifyPlaybookVersionInfo();
        body.withActionStrategy("sync");
        body.withDataobjectDelete(true);
        body.withDataobjectUpdate(true);
        body.withDataobjectCreate(true);
        body.withTriggerType("event");
        body.withRuleId("4185bbd2-9d18-4362-92cb-46df0b24fe4e");
        body.withStatus("UNPASSED");
        body.withEnabled(true);
        body.withRuleEnable(true);
        body.withDataclassId("909494e3-558e-46b6-a9eb-07a8e18ca62f");
        body.withPlaybookId("909494e3-558e-46b6-a9eb-07a8e18ca62f");
        body.withWorkspaceId("string");
        body.withDescription("This my XXXX");
        request.withBody(body);
        try {
            UpdatePlaybookVersionResponse response = client.updatePlaybookVersion(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

更新一个剧本版本,剧本版本所属工作空间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
# 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 = UpdatePlaybookVersionRequest()
        request.workspace_id = "{workspace_id}"
        request.version_id = "{version_id}"
        request.body = ModifyPlaybookVersionInfo(
            action_strategy="sync",
            dataobject_delete=True,
            dataobject_update=True,
            dataobject_create=True,
            trigger_type="event",
            rule_id="4185bbd2-9d18-4362-92cb-46df0b24fe4e",
            status="UNPASSED",
            enabled=True,
            rule_enable=True,
            dataclass_id="909494e3-558e-46b6-a9eb-07a8e18ca62f",
            playbook_id="909494e3-558e-46b6-a9eb-07a8e18ca62f",
            workspace_id="string",
            description="This my XXXX"
        )
        response = client.update_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

更新一个剧本版本,剧本版本所属工作空间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
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.UpdatePlaybookVersionRequest{}
	request.WorkspaceId = "{workspace_id}"
	request.VersionId = "{version_id}"
	actionStrategyModifyPlaybookVersionInfo:= "sync"
	dataobjectDeleteModifyPlaybookVersionInfo:= true
	dataobjectUpdateModifyPlaybookVersionInfo:= true
	dataobjectCreateModifyPlaybookVersionInfo:= true
	triggerTypeModifyPlaybookVersionInfo:= "event"
	ruleIdModifyPlaybookVersionInfo:= "4185bbd2-9d18-4362-92cb-46df0b24fe4e"
	statusModifyPlaybookVersionInfo:= "UNPASSED"
	enabledModifyPlaybookVersionInfo:= true
	ruleEnableModifyPlaybookVersionInfo:= true
	dataclassIdModifyPlaybookVersionInfo:= "909494e3-558e-46b6-a9eb-07a8e18ca62f"
	playbookIdModifyPlaybookVersionInfo:= "909494e3-558e-46b6-a9eb-07a8e18ca62f"
	workspaceIdModifyPlaybookVersionInfo:= "string"
	descriptionModifyPlaybookVersionInfo:= "This my XXXX"
	request.Body = &model.ModifyPlaybookVersionInfo{
		ActionStrategy: &actionStrategyModifyPlaybookVersionInfo,
		DataobjectDelete: &dataobjectDeleteModifyPlaybookVersionInfo,
		DataobjectUpdate: &dataobjectUpdateModifyPlaybookVersionInfo,
		DataobjectCreate: &dataobjectCreateModifyPlaybookVersionInfo,
		TriggerType: &triggerTypeModifyPlaybookVersionInfo,
		RuleId: &ruleIdModifyPlaybookVersionInfo,
		Status: &statusModifyPlaybookVersionInfo,
		Enabled: &enabledModifyPlaybookVersionInfo,
		RuleEnable: &ruleEnableModifyPlaybookVersionInfo,
		DataclassId: &dataclassIdModifyPlaybookVersionInfo,
		PlaybookId: &playbookIdModifyPlaybookVersionInfo,
		WorkspaceId: &workspaceIdModifyPlaybookVersionInfo,
		Description: &descriptionModifyPlaybookVersionInfo,
	}
	response, err := client.UpdatePlaybookVersion(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求成功响应信息

400

请求失败响应信息

错误码

请参见错误码

相关文档