# 创建剧本动作 - CreatePlaybookAction #### 功能介绍 创建剧本动作 #### 调用方法 请参见[如何调用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 POST /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/versions/{version_id}/actions 表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 普通API请求的类型 **约束限制：** 不涉及 **取值范围：** - application/json **默认取值：** application/json | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | \[数组元素\] | 是 | Array of [CreateAction] objects | Action列表 | 表4CreateAction | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | 名称 | | description | 否 | String | 描述 | | action_type | 是 | String | **参数解释：** 动作类型 - AOP_WORKFLOW 流程 **约束限制：** 不涉及 **取值范围：** - AOP_WORKFLOW **默认取值：** AOP_WORKFLOW | | action_id | 是 | String | 剧本动作ID | | sort_order | 否 | String | 排序方式 | #### 响应参数 **状态码：200** 表5响应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接口创建Action信息。 | 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | 错误码 | | message | String | 错误信息 | | data | Array of [ActionInfo] objects | 剧本Action列表 | 表7ActionInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 剧本流程动作ID | | name | String | 流程动作名称 | | description | String | 描述 | | action_type | String | **参数解释：** 动作类型 - AOP_WORKFLOW 流程 **约束限制：** 不涉及 **取值范围：** - AOP_WORKFLOW **默认取值：** AOP_WORKFLOW | | action_id | String | 流程ID | | playbook_id | String | 剧本ID | | playbook_version_id | String | 剧本版本ID | | project_id | String | 项目ID | **状态码：400** 表8响应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接口 | 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释**: 错误码 **取值范围**: 不涉及 | | message | String | **参数解释**: 错误描述 **取值范围**: 不涉及 | #### 请求示例 创建一个剧本动作，剧本名称为名称，描述为This is a description.，剧本动作类型为aopworkflow，剧本动作ID为909494e3-558e-46b6-a9eb-07a8e18ca62f，排序顺序为string。 ``` [ { "name" : "name", "description" : "This is a description.", "action_type" : "aopworkflow", "action_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "sort_order" : "string" } ] ``` #### 响应示例 **状态码：200** 请求成功响应信息 ``` { "code" : 0, "message" : "success", "data" : [ { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "name", "description" : "This is a description.", "action_type" : "Workflow", "action_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "playbook_id" : "string", "playbook_version_id" : "string", "project_id" : "string" } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 创建一个剧本动作，剧本名称为名称，描述为This is a description.，剧本动作类型为aopworkflow，剧本动作ID为909494e3-558e-46b6-a9eb-07a8e18ca62f，排序顺序为string。 ``` 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 CreatePlaybookActionSolution { 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(); CreatePlaybookActionRequest request = new CreatePlaybookActionRequest(); request.withWorkspaceId("{workspace_id}"); request.withVersionId("{version_id}"); List listbodyCreateActionInfo = new ArrayList<>(); listbodyCreateActionInfo.add( new CreateAction() .withName("name") .withDescription("This is a description.") .withActionType("aopworkflow") .withActionId("909494e3-558e-46b6-a9eb-07a8e18ca62f") .withSortOrder("string") ); request.withBody(listbodyCreateActionInfo); try { CreatePlaybookActionResponse response = client.createPlaybookAction(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] 创建一个剧本动作，剧本名称为名称，描述为This is a description.，剧本动作类型为aopworkflow，剧本动作ID为909494e3-558e-46b6-a9eb-07a8e18ca62f，排序顺序为string。 ``` # 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 = CreatePlaybookActionRequest() request.workspace_id = "{workspace_id}" request.version_id = "{version_id}" listCreateActionInfobody = [ CreateAction( name="name", description="This is a description.", action_type="aopworkflow", action_id="909494e3-558e-46b6-a9eb-07a8e18ca62f", sort_order="string" ) ] request.body = listCreateActionInfobody response = client.create_playbook_action(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] 创建一个剧本动作，剧本名称为名称，描述为This is a description.，剧本动作类型为aopworkflow，剧本动作ID为909494e3-558e-46b6-a9eb-07a8e18ca62f，排序顺序为string。 ``` 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.CreatePlaybookActionRequest{} request.WorkspaceId = "{workspace_id}" request.VersionId = "{version_id}" nameCreateActionInfo:= "name" descriptionCreateActionInfo:= "This is a description." sortOrderCreateActionInfo:= "string" var listCreateActionInfobody = []model.CreateAction{ { Name: &nameCreateActionInfo, Description: &descriptionCreateActionInfo, ActionType: "aopworkflow", ActionId: "909494e3-558e-46b6-a9eb-07a8e18ca62f", SortOrder: &sortOrderCreateActionInfo, }, } request.Body = &listCreateActionInfobody response, err := client.CreatePlaybookAction(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=CreatePlaybookAction&version=v1)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功响应信息 | | 400 | 请求失败响应信息 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。