Updated on 2026-02-05 GMT+08:00

Saving Component Configuration

Function

This API is used to save component configuration.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/components/{component_id}/configurations

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

component_id

Yes

String

Component ID.

workspace_id

Yes

String

Workspace ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

configuration

No

Array of ConfigurationDetail objects

Node configuration information.

Table 3 ConfigurationDetail

Parameter

Mandatory

Type

Description

config_status

No

String

Definition

Node deployment status.

  • UN_SAVED: to be saved

  • SAVE_AND_UN_APPLY: to be applied

  • MOVE_AND_UN_APPLY: to be removed

  • APPLYING: being applied

  • FAIL_APPLY: failed to be applied

  • APPLIED: applied

Constraints

N/A

Range

  • UN_SAVED

  • SAVE_AND_UN_APPLY

  • MOVE_AND_UN_APPLY

  • APPLYING

  • FAIL_APPLY

  • APPLIED

Default Value

N/A

list

Yes

Array of FileConfiguration objects

File configuration list.

node_id

No

String

Node ID.

node_name

No

String

Node name.

specification

No

String

Specifications.

Table 4 FileConfiguration

Parameter

Mandatory

Type

Description

file_name

No

String

File name.

file_type

Yes

String

Definition

File type.

  • JVM JVM configuration file type.

  • LOG4J2: Log4j2 log configuration file type

  • YML: YAML configuration file type

Constraints

N/A

Range

  • JVM

  • LOG4J2

  • YML

Default Value

N/A

node_id

No

String

Node ID.

param

Yes

Map<String,String>

Parameter.

type

No

String

Definition

Configuration type.

  • HISTORY: historical versions

  • CURRENT_SAVE: currently saved

  • CURRENT_APPLY: currently applied

Constraints

N/A

Range

  • HISTORY

  • CURRENT_SAVE

  • CURRENT_APPLY

Default Value

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

message

String

Result details.

result

String

Result.

Example Requests

https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/components/{component_id}/configurations

{
  "configuration" : [ {
    "config_status" : "SAVE_AND_UN_APPLY",
    "list" : [ {
      "file_name" : "log4j2.properties",
      "file_type" : "LOG4J2",
      "node_id" : "a3478ad5xxxbf7a",
      "param" : {
        "a.eventEol" : "true"
      },
      "type" : "CURRENT_APPLY"
    }, {
      "file_name" : "jvm.options",
      "file_type" : "JVM",
      "node_id" : "a3478ad5xxxbf7a",
      "param" : {
        "-Xmx" : "2048M"
      },
      "type" : "CURRENT_APPLY"
    } ],
    "node_id" : "a3478ad5xxxbf7a",
    "node_name" : "ecs-6xx9",
    "specification" : "2U|4G|100G"
  } ]
}

Example Responses

Status code: 200

Successful.

{
  "result" : "success"
}

SDK Sample Code

The SDK sample code is as follows.

 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
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.*;


public class UpdateComponentConfigurationSolution {

    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();
        UpdateComponentConfigurationRequest request = new UpdateComponentConfigurationRequest();
        request.withComponentId("{component_id}");
        request.withWorkspaceId("{workspace_id}");
        try {
            UpdateComponentConfigurationResponse response = client.updateComponentConfiguration(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());
        }
    }
}
 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
# 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("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateComponentConfigurationRequest()
        request.component_id = "{component_id}"
        request.workspace_id = "{workspace_id}"
        response = client.update_component_configuration(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := secmaster.NewSecMasterClient(
        secmaster.SecMasterClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateComponentConfigurationRequest{}
	request.ComponentId = "{component_id}"
	request.WorkspaceId = "{workspace_id}"
	response, err := client.UpdateComponentConfiguration(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

Successful.

Error Codes

See Error Codes.