# 更新剧本规则 - UpdatePlaybookRule #### 功能介绍 更新剧本规则 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-secmaster/secmaster_03_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-secmaster/secmaster_03_0023.html)。 #### URI PUT /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/versions/{version_id}/rules/{rule_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID | | workspace_id | 是 | String | 工作空间ID | | version_id | 是 | String | 剧本版本ID | | rule_id | 是 | String | 剧本规则ID | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | | content-type | 是 | String | **参数解释：** 内容类型 - application/json 普通API请求的类型 **约束限制：** 不涉及 **取值范围：** - application/json **默认取值：** application/json | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | rule | 否 | [ConditionInfo] object | 剧本触发规则详情 | 表4ConditionInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | expression_type | 否 | String | **参数解释：** 表达式类型 - common 通用表达式 **约束限制：** 事件触发剧本必填 **取值范围：** - common **默认取值：** common | | conditions | 否 | Array of [ConditionItem] objects | 触发条件。事件触发剧本必填 | | logics | 否 | Array of strings | 条件逻辑组合。事件触发剧本必填 | | cron | 否 | String | Cron 表达式（定时任务）。定时触发剧本必填 | | schedule_type | 否 | String | **参数解释：** 定时重复类型(second--秒, hour--小时,day--天，week-周)。 - second 秒 - hour 小时 - day 天 - week 周 **约束限制：** 定时触发剧本必填 **取值范围：** - second - hour - day - week **默认取值：** 无 | | start_type | 否 | String | **参数解释：** 剧本开始执行类型 - IMMEDIATELY 创建完成立即执行 - CUSTOM 自定义执行时间 **约束限制：** 定时触发剧本必填 **取值范围：** - IMMEDIATELY - CUSTOM **默认取值：** 无 | | end_type | 否 | String | **参数解释：** 剧本结束执行类型 - FOREVER 一直执行 - CUSTOM 自定义结束时间 **约束限制：** 定时触发剧本必填 **取值范围：** - FOREVER - CUSTOM **默认取值：** 无 | | end_time | 否 | String | 定时结束时间。定时触发剧本必填 | | start_time | 否 | String | 定时开始时间。定时触发剧本必填 | | repeat_range | 否 | String | 执行时间段 2021-01-30T23:00:00Z+0800。定时触发剧本必填 | | only_once | 否 | Boolean | 是否只执行一次。定时触发剧本必填 | | execution_type | 否 | String | **参数解释：** 执行队列类型 - PARALLEL 新任务与之前任务并行 - SERIAL_WAIT 不发起新任务 **约束限制：** 定时触发剧本必填 **取值范围：** - PARALLEL - SERIAL_WAIT **默认取值：** 无 | 表5ConditionItem | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | 条件名称 | | detail | 否 | String | 条件详情 | | data | 否 | Array of strings | 条件表达式数据 | #### 响应参数 **状态码：200** 表6响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-request-id | String | 请求ID,格式为：request_uuid-timestamp-hostname | | X-API-Deprecation-Date | String | 下线时间： 2026-12-31 | | X-API-Deprecation-Info | String | API即将下线，使用UpdatePlaybookVersion接口更新Rule信息。 | 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | 错误码 | | message | String | 错误信息 | | data | [RuleInfo] object | 剧本触发规格信息 | 表8RuleInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 规则ID | | project_id | String | 项目ID | | rule | String | 触发规则 | **状态码：400** 表9响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-request-id | String | 请求ID,格式为：request_uuid-timestamp-hostname | | X-API-Deprecation-Date | String | 下线时间： 2026-12-31 | | X-API-Deprecation-Info | String | API即将下线，如果需要克隆剧本版本可以直接使用CreatePlaybookVersion接口 | 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释**: 错误码 **取值范围**: 不涉及 | | message | String | **参数解释**: 错误描述 **取值范围**: 不涉及 | #### 请求示例 更新一条剧本规则，名称为condition_0，表达式类型为所有， ``` { "rule" : { "expression_type" : "common", "conditions" : [ { "name" : "condition_0", "detail" : "123", "data" : [ "handle_status, ==, Open" ] } ], "logics" : [ "condition_0" ] } } ``` #### 响应示例 **状态码：200** 请求成功响应参数 ``` { "code" : 0, "message" : "success", "data" : { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "rule" : "909494e3-558e-46b6-a9eb-07a8e18ca62f" } } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 更新一条剧本规则，名称为condition_0，表达式类型为所有， ``` 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.v1.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v1.*; import com.huaweicloud.sdk.secmaster.v1.model.*; import java.util.List; import java.util.ArrayList; public class UpdatePlaybookRuleSolution { 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("")) .build(); UpdatePlaybookRuleRequest request = new UpdatePlaybookRuleRequest(); request.withWorkspaceId("{workspace_id}"); request.withVersionId("{version_id}"); request.withRuleId("{rule_id}"); ModifyRuleInfo body = new ModifyRuleInfo(); List listRuleLogics = new ArrayList<>(); listRuleLogics.add("condition_0"); List listConditionsData = new ArrayList<>(); listConditionsData.add("handle_status, ==, Open"); List listRuleConditions = new ArrayList<>(); listRuleConditions.add( new ConditionItem() .withName("condition_0") .withDetail("123") .withData(listConditionsData) ); ConditionInfo rulebody = new ConditionInfo(); rulebody.withExpressionType("common") .withConditions(listRuleConditions) .withLogics(listRuleLogics); body.withRule(rulebody); request.withBody(body); try { UpdatePlaybookRuleResponse response = client.updatePlaybookRule(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] 更新一条剧本规则，名称为condition_0，表达式类型为所有， ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.v1 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("")) \ .build() try: request = UpdatePlaybookRuleRequest() request.workspace_id = "{workspace_id}" request.version_id = "{version_id}" request.rule_id = "{rule_id}" listLogicsRule = [ "condition_0" ] listDataConditions = [ "handle_status, ==, Open" ] listConditionsRule = [ ConditionItem( name="condition_0", detail="123", data=listDataConditions ) ] rulebody = ConditionInfo( expression_type="common", conditions=listConditionsRule, logics=listLogicsRule ) request.body = ModifyRuleInfo( rule=rulebody ) response = client.update_playbook_rule(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] 更新一条剧本规则，名称为condition_0，表达式类型为所有， ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := secmaster.NewSecMasterClient(hcClient) request := &model.UpdatePlaybookRuleRequest{} request.WorkspaceId = "{workspace_id}" request.VersionId = "{version_id}" request.RuleId = "{rule_id}" var listLogicsRule = []string{ "condition_0", } var listDataConditions = []string{ "handle_status, ==, Open", } nameConditions:= "condition_0" detailConditions:= "123" var listConditionsRule = []model.ConditionItem{ { Name: &nameConditions, Detail: &detailConditions, Data: &listDataConditions, }, } expressionTypeRule:= "common" rulebody := &model.ConditionInfo{ ExpressionType: &expressionTypeRule, Conditions: &listConditionsRule, Logics: &listLogicsRule, } request.Body = &model.ModifyRuleInfo{ Rule: rulebody, } response, err := client.UpdatePlaybookRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SecMaster/sdk?api=UpdatePlaybookRule&version=v1)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功响应参数 | | 400 | 请求失败响应参数 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。