Updated on 2025-06-24 GMT+08:00

Updating a Playbook Workflow

Function

This API is used to update a playbook workflow.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

workspace_id

Yes

String

Workspace ID.

version_id

Yes

String

Playbook version ID.

action_id

Yes

String

Playbook workflow ID.

Request Parameters

Table 2 Request header 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 the user token.

content-type

Yes

String

application/json;charset=UTF-8

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

No

String

Name.

description

No

String

Description.

action_type

No

String

Type. The default value is AOP_WORKFLOW.

action_id

No

String

Playbook workflow ID.

sort_order

No

String

Sorting method.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID. Format: request_uuid-timestamp-hostname.

Table 5 Response body parameters

Parameter

Type

Description

code

String

Error code

message

String

Error message

data

ActionInfo object

Playbook workflow information.

Table 6 ActionInfo

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

Table 7 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID. Format: request_uuid-timestamp-hostname.

Table 8 Response body parameters

Parameter

Type

Description

code

String

Error code.

message

String

Error description.

Example Requests

Update a playbook workflow. Workflow name: MyXXX; Description: This my XXXX; Workflow type: aopworkflow; Workflow ID: 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 parameters for a successful request.

{
  "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.

Java

Update a playbook workflow. Workflow name: MyXXX; Description: This my XXXX; Workflow type: aopworkflow; Workflow ID: 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
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 UpdatePlaybookActionSolution {

    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();
        UpdatePlaybookActionRequest request = new UpdatePlaybookActionRequest();
        request.withWorkspaceId("{workspace_id}");
        request.withVersionId("{version_id}");
        request.withActionId("{action_id}");
        ModifyActionInfo body = new ModifyActionInfo();
        body.withSortOrder("string");
        body.withActionId("909494e3-558e-46b6-a9eb-07a8e18ca62f");
        body.withActionType("aopworkflow");
        body.withDescription("This my XXXX");
        body.withName("MyXXX");
        request.withBody(body);
        try {
            UpdatePlaybookActionResponse response = client.updatePlaybookAction(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

Update a playbook workflow. Workflow name: MyXXX; Description: This my XXXX; Workflow type: aopworkflow; Workflow ID: 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
# 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 = UpdatePlaybookActionRequest()
        request.workspace_id = "{workspace_id}"
        request.version_id = "{version_id}"
        request.action_id = "{action_id}"
        request.body = ModifyActionInfo(
            sort_order="string",
            action_id="909494e3-558e-46b6-a9eb-07a8e18ca62f",
            action_type="aopworkflow",
            description="This my XXXX",
            name="MyXXX"
        )
        response = client.update_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

Update a playbook workflow. Workflow name: MyXXX; Description: This my XXXX; Workflow type: aopworkflow; Workflow ID: 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.UpdatePlaybookActionRequest{}
	request.WorkspaceId = "{workspace_id}"
	request.VersionId = "{version_id}"
	request.ActionId = "{action_id}"
	sortOrderModifyActionInfo:= "string"
	actionIdModifyActionInfo:= "909494e3-558e-46b6-a9eb-07a8e18ca62f"
	actionTypeModifyActionInfo:= "aopworkflow"
	descriptionModifyActionInfo:= "This my XXXX"
	nameModifyActionInfo:= "MyXXX"
	request.Body = &model.ModifyActionInfo{
		SortOrder: &sortOrderModifyActionInfo,
		ActionId: &actionIdModifyActionInfo,
		ActionType: &actionTypeModifyActionInfo,
		Description: &descriptionModifyActionInfo,
		Name: &nameModifyActionInfo,
	}
	response, err := client.UpdatePlaybookAction(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

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 parameters for a successful request.

400

Response parameters for failed requests.

Error Codes

See Error Codes.