文档首页/ 安全云脑 SecMaster/ API参考/ 安全云脑 API V1/ 云日志资源/ 创建租户行管订阅 - CreateTenantManaged
更新时间:2026-09-24 GMT+08:00
分享

创建租户行管订阅 - CreateTenantManaged

功能介绍

创建租户行管订阅

调用方法

请参见如何调用API。

授权信息

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

URI

POST /v1/{project_id}/workspaces/{workspace_id}/siem/cloud-logs/tenant/config

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

是

String

参数解释:

工作空间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

约束限制:

不涉及

取值范围:

只能由英文字母、数字、中文、下划线、中划线、点号组成,且长度为32~36个字符。

默认取值:

不涉及

dataspace_name

是

String

参数解释:

数据空间名称

约束限制:

不涉及

取值范围:

只能由英文字母、数字、中文、下划线、中划线、点号组成,且长度为1~255个字符。

默认取值:

不涉及

domain_id

否

String

参数解释:

账户id

约束限制:

不涉及

取值范围:

只能由英文字母、数字、中文、下划线、中划线、点号组成,且长度为0~1024个字符。

默认取值:

必填

workspace_id

是

String

参数解释:

工作空间id

约束限制:

不涉及

取值范围:

只能由英文字母、数字、中文、下划线、中划线、点号组成,且长度为32~36个字符。

默认取值:

必填

表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

默认取值:

不涉及

响应参数

状态码:200

表6 响应Body参数

参数

参数类型

描述

[数组元素]

Array of ConfigResponse objects

参数解释:

保存云服务采集配置响应

表7 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

表8 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: 平台行管

表9 reference

参数

参数类型

描述

csvc_display

String

参数解释:

云服务描述

取值范围:

不涉及

source_display

String

参数解释:

数据源描述

取值范围:

不涉及

link

String

参数解释:

链接

取值范围:

不涉及

csvc_help

String

参数解释:

云服务帮助说明

取值范围:

不涉及

source_help

String

参数解释:

数据源帮助说明

取值范围:

不涉及

表10 TargetInfo

参数

参数类型

描述

pipe

String

参数解释:

管道名

取值范围:

长度为1~255个字符

shards

Long

参数解释:

所需分区数

取值范围:

0~99

ttl

Long

参数解释:

数据生命周期

取值范围:

0~999999

状态码:400

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

取值范围:

长度为8~36个字符

error_msg

String

参数解释:

错误描述

取值范围:

长度为2~512个字符

请求示例

在某个工作空间创建一个厂商的请求样例

https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/siem/cloud-logs/tenant/config

{
  "config" : [ {
    "accounts" : [ "domain_id" ],
    "action" : "CREATE(创建) DELETE(删除) ALL(全量数据)",
    "alert" : true,
    "all_accounts" : true,
    "csvc" : "hss",
    "csvc_display" : "主机安全",
    "enable" : 1,
    "new_account_auto_access" : true,
    "shards" : 2,
    "source_display" : "主机安全告警",
    "source_id" : 27,
    "source_name" : "主机安全告警",
    "ttl" : 180
  } ],
  "dataspace_id" : "a00106ba-bede-453c-8488-b60c70bd6aed",
  "dataspace_name" : "cloudlogs_2b31ed520xxxxxxebedb6e57xxxxxxxx",
  "domain_id" : "0531ed520xxxxxxebedb6e57xxxxxxxx,0531ed520xxxxxxebedb6e57xxxxxxxx",
  "workspace_id" : "c22106ba-bede-453c-8488-b60c70bd6aed"
}

响应示例

状态码:200

成功

[ {
  "alert" : true,
  "allow_alert" : true,
  "allow_lts" : false,
  "csvc_display" : "企业主机安全 HSS",
  "datasets" : [ {
    "csvc" : "hss",
    "enable" : "1",
    "is_region" : 0,
    "reference" : {
      "csvc_display" : "企业主机安全 HSS",
      "source_display" : "主机漏洞扫描结果",
      "link" : "",
      "csvc_help" : "企业主机安全服务",
      "source_help" : "主机漏洞扫描结果"
    },
    "source_id" : 102,
    "source_name" : "hss-vul",
    "target" : { },
    "type" : 1
  } ],
  "region" : false,
  "source_display" : "主机漏洞扫描结果",
  "success" : true,
  "total" : 1
} ]

状态码:400

错误响应

{
  "error_code" : "SecMaster.10000001",
  "error_msg" : "参数无效"
}

状态码

状态码

描述

200

成功

400

错误响应

错误码

请参见错误码。

相关文档