Creating a Configuration Application

Function

This API is used to create a configuration application.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Value Range N/A Default value N/A
workspace_id	Yes	String	Workspace ID.
component_id	Yes	String	Component ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
configuration	Yes	Array of ConfigurationDetail objects	Configuration list.

**Table 4** 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 5** 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 6** Response body parameters
Parameter	Type	Description
apply_fail_list	Array of ComponentConfiguration objects	List of instances that fail to be created.
apply_success_list	Array of ComponentConfiguration objects	List of instances that are successfully created.

**Table 7** ComponentConfiguration
Parameter	Type	Description
component_id	String	Component ID.
component_name	String	Component name.
config_status	String	Definition Node configuration 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
create_time	Integer	Millisecond timestamp.
fail_deploy_message	String	Deployment failure message.
ip_address	String	IP address.
list	Array of ComponentConfigurationParam objects	Component configuration parameters.
monitor	Monitor object	Monitor.
node_apply_fail_enum	String	Definition Node application status and reason. COLLECTOR_USE: The collector is in use and cannot be removed. NODE_OFFLINE: The node is disconnected and cannot be applied. Constraints N/A Range COLLECTOR_USE NODE_OFFLINE Default Value N/A
node_expansion	IsapNodeExpansion object	Node extension information.
node_id	String	Node ID.
node_name	String	Node name.
private_ip_address	String	IP address.
region	String	Region.
specification	String	Specifications.
vpc_endpoint_address	String	VPC endpoint address.
vpc_endpoint_id	String	VPC endpoint ID.

**Table 8** ComponentConfigurationParam
Parameter	Type	Description
component_id	String	Component ID.
configuration_id	String	Configuration ID.
file_name	String	File name.
file_path	String	File path.
file_type	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	String	Node ID.
param	String	Parameter.
type	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
version	Integer	Version.

**Table 9** Monitor
Parameter	Type	Description
cpu_idle	String	Percentage of CPU idle time.
cpu_usage	String	Current CPU usage.
disk_count	String	Number of disk devices in the system.
disk_usage	String	Current disk space usage.
down_pps	String	Number of downloaded data packets per second.
health_status	String	Definition Health status of nodes. NORMAL: normal ANOMALIES: abnormal FAULTS: faulty LOST_CONTACT: disconnected Constraints N/A Range NORMAL ANOMALIES FAULTS LOST_CONTACT Default Value N/A
heart_beat	String	Definition Whether the node can successfully receive the heartbeat signal. ONLINE: It is online. OFFLINE: It is offline. Constraints N/A Range ONLINE OFFLINE Default Value N/A
heart_beat_time	Long	Time when the last heartbeat signal was received.
memory_cache	String	Memory size of cached data.
memory_count	String	Number of physical memory modules.
memory_free	String	Current free physical memory.
memory_shared	String	Total memory shared by multiple processes.
memory_usage	String	Used physical memory.
mini_on_online	String	Online or not.
read_rate	String	Disk read rate.
up_pps	String	Number of uploaded data packets per second.
write_rate	String	Disk write rate.

**Table 10** IsapNodeExpansion
Parameter	Type	Description
custom_label	String	Custom tag.
data_center	String	Data center.
description	String	Description.
maintainer	String	Maintenance engineer.
network_plane	String	Network plane.
node_id	String	UUID

Status code: 400

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

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

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

{
  "apply_success_list" : [ {
    "component_id" : "1603635xxx1444",
    "component_name" : "logstash",
    "config_status" : "SAVE_AND_UN_APPLY",
    "create_time" : 1756351117715,
    "node_id" : "a3478ad5xxxbf7a",
    "node_name" : "ecs-6xx9",
    "specification" : "2U|4G|100G"
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

      
       
         
         
           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 CreateConfigurationApplicationSolution {

    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();
        CreateConfigurationApplicationRequest request = new CreateConfigurationApplicationRequest();
        request.withWorkspaceId("{workspace_id}");
        request.withComponentId("{component_id}");
        try {
            CreateConfigurationApplicationResponse response = client.createConfigurationApplication(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());
        }
    }
}

          

        

      
     

      
       
         
         
           # 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 = CreateConfigurationApplicationRequest()
        request.workspace_id = "{workspace_id}"
        request.component_id = "{component_id}"
        response = client.create_configuration_application(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

      
       
         
         
           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.CreateConfigurationApplicationRequest{}
	request.WorkspaceId = "{workspace_id}"
	request.ComponentId = "{component_id}"
	response, err := client.CreateConfigurationApplication(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     