文档首页/ 安全云脑 SecMaster/ API参考/ 安全云脑 API V1/ 云服务接入/ 保存云服务采集配置 - CreateCollectConfig
更新时间:2026-09-24 GMT+08:00
分享

保存云服务采集配置 - CreateCollectConfig

功能介绍

保存云服务采集配置

调用方法

请参见如何调用API。

授权信息

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

URI

POST /v1/{project_id}/collector/cloudlogs/config

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

region_id

否

String

参数解释:

区域ID,用于标识资源所属区域。

约束限制:

不涉及

取值范围:

长度为0~256个字符。

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

config

是

Array of ConfigInfo objects

数据集列表

dataspace_id

是

String

数据空间ID

dataspace_name

是

String

数据空间名称

domain_id

否

String

账号ID

lts_config

否

Array of LtsRquestVo objects

lts配置

workspace_id

是

String

工作空间 id

表5 ConfigInfo

参数

是否必选

参数类型

描述

accounts

否

Array of strings

参数解释:

纳管账号列表,非跨账号场景不传递。

约束限制:

不涉及

action

否

String

参数解释:

操作类型,用于指定数据采集的操作方式。

约束限制:

不涉及

取值范围:

长度为0~255个字符。

默认取值:

不涉及

alert

否

Boolean

参数解释:

自动转告警的开关。

约束限制:

不涉及

取值范围:

  • true:启用

  • false:禁用

默认取值:

不涉及

all_accounts

否

Boolean

参数解释:

是否接入已纳管的全量账号。

约束限制:

不涉及

取值范围:

  • true:接入全量账号

  • false:未接入全量账号

默认取值:

不涉及

csvc

否

String

参数解释:

云产品,用于标识数据来源的云服务。

约束限制:

不涉及

取值范围:

长度为1~255个字符。

默认取值:

不涉及

csvc_display

是

String

参数解释:

云服务描述,用于展示云服务的名称。

约束限制:

不涉及

取值范围:

长度为1~255个字符。

默认取值:

不涉及

enable

是

Long

参数解释:

启用状态。

约束限制:

不涉及

取值范围:

0~10

默认取值:

不涉及

new_account_auto_access

否

Boolean

参数解释:

新账号自动同步的开关。

约束限制:

不涉及

取值范围:

  • true:启用

  • false:禁用

默认取值:

不涉及

shards

是

Long

参数解释:

所需分区数,用于指定数据采集的分区数量。

约束限制:

不涉及

取值范围:

0~99

默认取值:

不涉及

source_display

是

String

参数解释:

数据源描述,用于展示数据源的名称。

约束限制:

不涉及

取值范围:

长度为1~255个字符。

默认取值:

不涉及

source_id

是

Long

参数解释:

数据源ID,用于标识数据来源。

约束限制:

不涉及

取值范围:

0~9223372036854775807

默认取值:

不涉及

source_name

否

String

参数解释:

日志名称,用于标识数据来源的日志类型。

约束限制:

不涉及

取值范围:

长度为1~255个字符。

默认取值:

不涉及

ttl

是

Long

参数解释:

数据生命周期,单位:天。

约束限制:

不涉及

取值范围:

7~180

默认取值:

不涉及

表6 LtsRquestVo

参数

是否必选

参数类型

描述

config_name

否

String

配置名称

description

否

String

描述

enable

否

String

是否开启

log_group_id

否

String

日志ID

log_stream_id

否

String

日志流ID

log_type

否

String

日志类型

log_type_prefix

否

String

日志前缀

pipe_alias

否

String

日志别名

响应参数

状态码:200

表7 响应Body参数

参数

参数类型

描述

[数组元素]

Array of ConfigResponse objects

参数解释:

保存云服务采集配置响应

表8 ConfigResponse

参数

参数类型

描述

alert

Boolean

参数解释:

自动转告警的开关

取值范围:

  • true: 开启自动转告警

  • false: 关闭自动转告警

allow_alert

Boolean

参数解释:

能否开自动转告警

取值范围:

  • true: 可以开启自动转告警

  • false: 不可开启自动转告警

allow_lts

Boolean

参数解释:

是否允许长期存储

取值范围:

  • true: 允许长期存储

  • false: 不允许长期存储

csvc_display

String

参数解释:

云服务描述

取值范围:

长度为1~255个字符

datasets

Array of DatasetInfo objects

参数解释:

关联的数据集列表

region

Boolean

参数解释:

是否按区域分片采集

取值范围:

  • true: 按区域分片采集

  • false: 不按区域分片采集

source_display

String

参数解释:

数据源描述

取值范围:

长度为1~255个字符

success

Boolean

参数解释:

是否创建成功

取值范围:

  • true: 创建成功

  • false: 创建失败

total

Integer

参数解释:

当前已采集的日志条数

取值范围:

0~10000

表9 DatasetInfo

参数

参数类型

描述

csvc

String

参数解释:

所属云服务,例如主机安全就填写hss

取值范围:

长度为1~255个字符

enable

String

参数解释:

启用状态

取值范围:

  • 0: 未启用

  • 1: 启用

is_region

Long

参数解释:

位置信息

取值范围:

  • 0: global

  • 1: region

reference

reference object

参数解释:

数据源引用信息

取值范围:

不涉及

source_id

Long

参数解释:

数据源ID

取值范围:

0~9223372036854775807

source_name

String

参数解释:

数据源名称

取值范围:

长度为1~255个字符

target

Object

参数解释:

目标管道信息

取值范围:

不涉及

type

Long

参数解释:

订阅类型

取值范围:

  • 1: 租户订阅

  • 2: 租户行管订阅

  • 3: 平台行管

表10 reference

参数

参数类型

描述

csvc_display

String

参数解释:

云服务描述

取值范围:

不涉及

source_display

String

参数解释:

数据源描述

取值范围:

不涉及

link

String

参数解释:

链接

取值范围:

不涉及

csvc_help

String

参数解释:

云服务帮助说明

取值范围:

不涉及

source_help

String

参数解释:

数据源帮助说明

取值范围:

不涉及

表11 TargetInfo

参数

参数类型

描述

pipe

String

参数解释:

管道名

取值范围:

长度为1~255个字符

shards

Long

参数解释:

所需分区数

取值范围:

0~99

ttl

Long

参数解释:

数据生命周期

取值范围:

0~999999

请求示例

保存云服务日志订阅

{
  "domain_id" : "9f284xxxe322",
  "workspace_id" : "25a81xxx360c",
  "dataspace_name" : "dataspace_a",
  "dataspace_id" : "718sxxxgh29",
  "config" : [ {
    "source_id" : 601,
    "enable" : 0,
    "alert" : false,
    "ttl" : 7,
    "shards" : 1,
    "csvc_display" : "CTS",
    "source_display" : "CTS log",
    "csvc" : "cts",
    "source_name" : "cts-audit"
  } ]
}

响应示例

状态码:200

[ {
  "alert" : false,
  "allow_alert" : false,
  "allow_lts" : false,
  "csvc_display" : "云审计服务 CTS",
  "datasets" : [ ],
  "region" : false,
  "source_display" : "云审计服务日志",
  "success" : true,
  "total" : 0
} ]

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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
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.*;

import java.util.List;
import java.util.ArrayList;

public class CreateCollectConfigSolution {

    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();
        CreateCollectConfigRequest request = new CreateCollectConfigRequest();
        CreateCollectConfigV2RequestBody body = new CreateCollectConfigV2RequestBody();
        List<ConfigInfo> listbodyConfig = new ArrayList<>();
        listbodyConfig.add(
            new ConfigInfo()
                .withAlert(false)
                .withCsvc("cts")
                .withCsvcDisplay("CTS")
                .withEnable(0L)
                .withShards(1L)
                .withSourceDisplay("CTS log")
                .withSourceId(601L)
                .withSourceName("cts-audit")
                .withTtl(7L)
        );
        body.withWorkspaceId("25a81xxx360c");
        body.withDomainId("9f284xxxe322");
        body.withDataspaceName("dataspace_a");
        body.withDataspaceId("718sxxxgh29");
        body.withConfig(listbodyConfig);
        request.withBody(body);
        try {
            CreateCollectConfigResponse response = client.createCollectConfig(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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# 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 = CreateCollectConfigRequest()
        listConfigbody = [
            ConfigInfo(
                alert=False,
                csvc="cts",
                csvc_display="CTS",
                enable=0,
                shards=1,
                source_display="CTS log",
                source_id=601,
                source_name="cts-audit",
                ttl=7
            )
        ]
        request.body = CreateCollectConfigV2RequestBody(
            workspace_id="25a81xxx360c",
            domain_id="9f284xxxe322",
            dataspace_name="dataspace_a",
            dataspace_id="718sxxxgh29",
            config=listConfigbody
        )
        response = client.create_collect_config(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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := secmaster.SecMasterClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := secmaster.NewSecMasterClient(hcClient)

    request := &model.CreateCollectConfigRequest{}
	alertConfig:= false
	csvcConfig:= "cts"
	sourceNameConfig:= "cts-audit"
	var listConfigbody = []model.ConfigInfo{
        {
            Alert: &alertConfig,
            Csvc: &csvcConfig,
            CsvcDisplay: "CTS",
            Enable: int64(0),
            Shards: int64(1),
            SourceDisplay: "CTS log",
            SourceId: int64(601),
            SourceName: &sourceNameConfig,
            Ttl: int64(7),
        },
    }
	domainIdCreateCollectConfigV2RequestBody:= "9f284xxxe322"
	request.Body = &model.CreateCollectConfigV2RequestBody{
		WorkspaceId: "25a81xxx360c",
		DomainId: &domainIdCreateCollectConfigV2RequestBody,
		DataspaceName: "dataspace_a",
		DataspaceId: "718sxxxgh29",
		Config: listConfigbody,
	}
	response, err := client.CreateCollectConfig(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

成功

错误码

请参见错误码。

相关文档