数据类类型新增 - CreateCustomType
功能介绍
新增数据类类型
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/dataclasses/{dataclass_id}/types
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
workspace_id |
是 |
String |
参数解释: 工作空间ID 取值范围: 不涉及 |
|
dataclass_id |
是 |
String |
数据类的唯一ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
sub_category |
否 |
String |
子类型名称,告警类型、事件类型必填;威胁情报、漏洞类型、自定义类型不填 |
|
sub_category_code |
否 |
String |
子类型标识。告警类型、事件类型必填;威胁情报、漏洞类型、自定义类型不填 |
|
category |
否 |
String |
类型名称,告警类型、事件类型、威胁情报、漏洞类型必填;自定义类型不填 |
|
category_code |
否 |
String |
类型标识。告警类型、事件类型、威胁情报、漏洞类型必填;自定义类型不填 |
|
name |
否 |
String |
自定义类型名称。创建类型时,代表类型名称,创建子类型时,代表子类型名称。(自定义类型必填,其余类型不填) |
|
business_code |
否 |
String |
自定义类型标识。创建类型时代表类型标识;创建子类型时代表子类型标识。(自定义类型必填,其余类型不填) |
|
dataclass_business_code |
否 |
String |
数据类业务编码,创建自定义类型必填。(其余类型不填) |
|
description |
否 |
String |
类型描述 |
|
level |
否 |
Integer |
类型层级,创建自定义类型必填,枚举值:1-类型,2-子类型。(其余类型不填) |
|
enabled |
是 |
Boolean |
类型启用禁用状态,启用:true,禁用:false |
|
sla |
是 |
Long |
过期时间 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
响应码 |
|
message |
String |
响应消息 |
|
data |
Array of DataClassTypeLevelDetailInfo objects |
响应数据 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
类型id |
|
name |
String |
数据类类型大类/子类名称 |
|
business_code |
String |
数据类类型大类/子类业务编码 |
|
description |
String |
数据类类型大类/子类描述 |
|
enabled |
Boolean |
状态 |
|
level |
Integer |
类型层级,1-大类,2-子类 |
|
is_built_in |
Boolean |
是否内置,true内置,false非内置 |
|
sla |
Integer |
响应时长 |
|
creator_id |
String |
创建人id |
|
creator_name |
String |
创建人名称 |
|
modifier_id |
String |
修改人id |
|
modifier_name |
String |
修改人名称 |
|
create_time |
String |
创建时间 |
|
update_time |
String |
修改时间 |
|
dataclass_business_code |
String |
所属数据类业务编码 |
|
sub_count |
Integer |
包含子类数量 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
新增类型成功响应体 |
|
400 |
新增类型失败响应体 |
错误码
请参见错误码。