Creating a Playbook Action
Function
Creating a Playbook Action
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/versions/{version_id}/actions
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
workspace_id |
Yes |
String |
Workspace ID |
version_id |
Yes |
String |
Playbook version 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 a token. |
content-type |
Yes |
String |
application/json;charset=UTF-8 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
[items] |
Yes |
Array of CreateAction objects |
Create actions |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
Request ID, in the format request_uuid-timestamp-hostname. |
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code |
message |
String |
Error message |
data |
Array of ActionInfo objects |
list of informations of playbook action |
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. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
Request ID, in the format request_uuid-timestamp-hostname. |
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error Code |
message |
String |
Error Description |
Example Requests
Create a playbook workflow. Workflow name is MyXXX; Description is This my XXXX; Workflow type is aopworkflow; Workflow ID is 909494e3-558e-46b6-a9eb-07a8e18ca62f; Sorted by string.
[ { "name" : "MyXXX", "description" : "This my XXXX", "action_type" : "aopworkflow", "action_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "sort_order" : "string" } ]
Example Responses
Status code: 200
Response when the request is successful.
{ "code" : 0, "message" : "Error message", "data" : [ { "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" } ] }
SDK Sample Code
The SDK sample code is as follows.
Create a playbook workflow. Workflow name is MyXXX; Description is This my XXXX; Workflow type is aopworkflow; Workflow ID is 909494e3-558e-46b6-a9eb-07a8e18ca62f; Sorted by string.
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 |
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 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("<YOUR REGION>")) .build(); CreatePlaybookActionRequest request = new CreatePlaybookActionRequest(); request.withWorkspaceId("{workspace_id}"); request.withVersionId("{version_id}"); List<CreateAction> listbodyCreateActionInfo = new ArrayList<>(); listbodyCreateActionInfo.add( new CreateAction() .withName("MyXXX") .withDescription("This my XXXX") .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()); } } } |
Create a playbook workflow. Workflow name is MyXXX; Description is This my XXXX; Workflow type is aopworkflow; Workflow ID is 909494e3-558e-46b6-a9eb-07a8e18ca62f; Sorted by string.
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 |
# 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 = CreatePlaybookActionRequest() request.workspace_id = "{workspace_id}" request.version_id = "{version_id}" listCreateActionInfobody = [ CreateAction( name="MyXXX", description="This my XXXX", 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) |
Create a playbook workflow. Workflow name is MyXXX; Description is This my XXXX; Workflow type is aopworkflow; Workflow ID is 909494e3-558e-46b6-a9eb-07a8e18ca62f; Sorted by string.
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 |
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.CreatePlaybookActionRequest{} request.WorkspaceId = "{workspace_id}" request.VersionId = "{version_id}" nameCreateActionInfo:= "MyXXX" descriptionCreateActionInfo:= "This my XXXX" 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) } } |
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 when the request is successful. |
400 |
Response when the request failed. |
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