文档首页/ 安全云脑 SecMaster/ API参考/ 安全云脑 API V1/ 组件管理/ 创建配置应用 - CreateConfigurationApplication
更新时间:2026-01-29 GMT+08:00
分享

创建配置应用 - CreateConfigurationApplication

功能介绍

创建配置应用

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

工作空间ID

component_id

String

组件ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

configuration

Array of ConfigurationDetail objects

配置列表

表4 ConfigurationDetail

参数

是否必选

参数类型

描述

config_status

String

参数解释:

节点部署状态

  • UN_SAVED 待保存

  • SAVE_AND_UN_APPLY 待应用

  • MOVE_AND_UN_APPLY 待移除

  • APPLYING 应用中

  • FAIL_APPLY 应用失败

  • APPLIED 应用完成

约束限制

不涉及

取值范围:

  • UN_SAVED

  • SAVE_AND_UN_APPLY

  • MOVE_AND_UN_APPLY

  • APPLYING

  • FAIL_APPLY

  • APPLIED

默认值

不涉及

list

Array of FileConfiguration objects

文件配置列表

node_id

String

节点ID

node_name

String

节点名称

specification

String

规范

表5 FileConfiguration

参数

是否必选

参数类型

描述

file_name

String

文件名称

file_type

String

参数解释:

文件类型

  • JVM JVM配置文件类型

  • LOG4J2 Log4j2日志配置文件类型

  • YML YAML配置文件类型

约束限制

不涉及

取值范围:

  • JVM

  • LOG4J2

  • YML

默认值

不涉及

node_id

String

节点ID

param

Map<String,String>

参数

type

String

参数解释:

配置类型

  • HISTORY 历史版本

  • CURRENT_SAVE 当前保存

  • CURRENT_APPLY 当前使用

约束限制

不涉及

取值范围:

  • HISTORY

  • CURRENT_SAVE

  • CURRENT_APPLY

默认值

不涉及

响应参数

状态码:200

表6 响应Body参数

参数

参数类型

描述

apply_fail_list

Array of ComponentConfiguration objects

创建失败实例列表

apply_success_list

Array of ComponentConfiguration objects

创建成功实例列表

表7 ComponentConfiguration

参数

参数类型

描述

component_id

String

组件id.

component_name

String

组件名称

config_status

String

参数解释:

节点配置状态

  • UN_SAVED 待保存

  • SAVE_AND_UN_APPLY 待应用

  • MOVE_AND_UN_APPLY 待移除

  • APPLYING 应用中

  • FAIL_APPLY 应用失败

  • APPLIED 应用完成

约束限制

不涉及

取值范围:

  • UN_SAVED

  • SAVE_AND_UN_APPLY

  • MOVE_AND_UN_APPLY

  • APPLYING

  • FAIL_APPLY

  • APPLIED

默认值

不涉及

create_time

Integer

毫秒时间戳

fail_deploy_message

String

部署失败的消息

ip_address

String

IP地址

list

Array of ComponentConfigurationParam objects

组件配置参数列表

monitor

Monitor object

监视器

node_apply_fail_enum

String

参数解释:

节点应用成功与否状态、原因

  • COLLECTOR_USE 采集器使用中,无法移除

  • NODE_OFFLINE 节点失联状态,无法应用

约束限制

不涉及

取值范围:

  • COLLECTOR_USE

  • NODE_OFFLINE

默认值

不涉及

node_expansion

IsapNodeExpansion object

节点扩展信息

node_id

String

节点ID

node_name

String

节点名称

private_ip_address

String

IP地址

region

String

地区

specification

String

规范

vpc_endpoint_address

String

VPC端点地址

vpc_endpoint_id

String

VPC端点ID

表8 ComponentConfigurationParam

参数

参数类型

描述

component_id

String

组件id.

configuration_id

String

配置ID

file_name

String

文件名称

file_path

String

文件路径

file_type

String

参数解释:

文件类型

  • JVM JVM配置文件类型

  • LOG4J2 Log4j2日志配置文件类型

  • YML YAML配置文件类型

约束限制

不涉及

取值范围:

  • JVM

  • LOG4J2

  • YML

默认值

不涉及

node_id

String

节点ID

param

String

参数

type

String

参数解释:

配置类型

  • HISTORY 历史版本

  • CURRENT_SAVE 当前保存

  • CURRENT_APPLY 当前使用

约束限制

不涉及

取值范围:

  • HISTORY

  • CURRENT_SAVE

  • CURRENT_APPLY

默认值

不涉及

version

Integer

版本

表9 Monitor

参数

参数类型

描述

cpu_idle

String

CPU 空闲时间的百分比

cpu_usage

String

CPU 当前的使用率

disk_count

String

系统中磁盘设备的数量

disk_usage

String

当前磁盘空间使用量

down_pps

String

下载数据包每秒数量

health_status

String

参数解释:

节点的健康状态

  • NORMAL 正常

  • ANOMALIES 异常

  • FAULTS 故障

  • LOST_CONTACT 失联

约束限制

不涉及

取值范围:

  • NORMAL

  • ANOMALIES

  • FAULTS

  • LOST_CONTACT

默认值

不涉及

heart_beat

String

参数解释:

节点是否成功收到心跳信号

  • ONLINE 在线

  • OFFLINE 离线

约束限制

不涉及

取值范围:

  • ONLINE

  • OFFLINE

默认值

不涉及

heart_beat_time

Long

最后一次接收到心跳信号的时间

memory_cache

String

缓存数据的内存大小

memory_count

String

物理内存条数量

memory_free

String

当前空闲的物理内存量

memory_shared

String

多个进程共享使用的内存总量

memory_usage

String

已使用的物理内存量

mini_on_online

String

是否在线

read_rate

String

磁盘读取速率

up_pps

String

上传数据包每秒数量

write_rate

String

磁盘写入速率

表10 IsapNodeExpansion

参数

参数类型

描述

custom_label

String

自定义标签

data_center

String

数据中心

description

String

描述信息

maintainer

String

维护人

network_plane

String

网络平面

node_id

String

UUID

状态码:400

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

响应示例

SDK代码示例

SDK代码示例如下。

 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 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());
        }
    }
}
 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 = 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)
 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.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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

成功

400

错误响应

错误码

请参见错误码

相关文档