# 保存云服务采集配置 - CreateCollectConfig #### 功能介绍 保存云服务采集配置 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-secmaster/secmaster_03_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-secmaster/secmaster_03_0023.html)。 #### URI POST /v1/{project_id}/collector/cloudlogs/config 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。[获取项目ID](https://support.huaweicloud.com/api-secmaster/secmaster_03_0014.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | region_id | 否 | String | 区域ID | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。[获取用户Token](https://support.huaweicloud.com/api-secmaster/secmaster_03_0010.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表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 | 表5ConfigInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | accounts | 否 | Array of strings | 纳管账号列表(非跨账号场景不传递) | | action | 否 | String | 操作 | | alert | 否 | Boolean | 自动转告警的开关 | | all_accounts | 否 | Boolean | 是否接入已纳管的全量账号 | | csvc | 否 | String | 云产品 | | csvc_display | 是 | String | 云服务描述 | | enable | 是 | Long | 启用状态：0未启用；1启用 | | new_account_auto_access | 否 | Boolean | 新账号自动同步的开关 | | shards | 是 | Long | 所需分区数 | | source_display | 是 | String | 数据源描述 | | source_id | 是 | Long | 数据源ID | | source_name | 否 | String | 日志名称 | | ttl | 是 | Long | 数据生命周期 | 表6LtsRquestVo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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 | 保存云服务采集配置响应 | 表8ConfigResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | alert | Boolean | 自动转告警的开关 | | allow_alert | Boolean | 能否开自动转告警 | | allow_lts | Boolean | 是否允许长期存储 | | csvc_display | String | 云服务描述 | | datasets | Array of [DatasetInfo] objects | 关联的数据集列表 | | region | Boolean | 是否按区域分片采集 | | source_display | String | 数据源描述 | | success | Boolean | 是否创建成功 | | total | Integer | 当前已采集的日志条数 | 表9DatasetInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | csvc | String | 所属云服务,例如主机安全就填写hss | | enable | String | 启用状态：0未启用；1启用 | | is_region | Long | 位置信息：1 region；0 global | | reference | [reference] object | 数据源名称 | | source_id | Long | 数据源ID | | source_name | String | 数据源名称 | | target | Object | 目标管道信息 | | type | Long | 订阅类型：1租户订阅；2租户行管订阅；3平台行管(当前都为1) | 表10reference | 参数 | 参数类型 | 描述 | |:---|:---|:---| | csvc_display | String | 云服务描述 | | source_display | String | 数据源描述 | | link | String | 链接 | | csvc_help | String | 云服务帮助说明 | | source_help | String | 数据源帮助说明 | 表11TargetInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | pipe | String | 管道名 | | shards | Long | 所需分区数 | | ttl | Long | 数据生命周期 | #### 请求示例 保存云服务日志订阅 ``` { "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代码示例如下。 - [Java] 保存云服务日志订阅 ``` 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("")) .build(); CreateCollectConfigRequest request = new CreateCollectConfigRequest(); CreateCollectConfigV2RequestBody body = new CreateCollectConfigV2RequestBody(); List 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()); } } } ``` - [Python] 保存云服务日志订阅 ``` # 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("")) \ .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) ``` - [Go] 保存云服务日志订阅 ``` 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("")). 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](https://console.huaweicloud.com/apiexplorer/#/openapi/SecMaster/sdk?api=CreateCollectConfig&version=v1)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。