新建模块 - CreateModule
功能介绍
创建模块.
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/modules
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取项目ID 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
workspace_id |
是 |
String |
参数解释： 工作空间id。 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。获取用户Token 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
content-type |
是 |
String |
参数解释： 内容类型
约束限制： 不涉及 取值范围：
默认取值： 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
否 |
String |
模块ID |
|
name |
是 |
String |
名称 |
|
description |
否 |
String |
描述信息 |
|
project_id |
否 |
String |
租户ID |
|
workspace_id |
否 |
String |
工作空间ID |
|
module_json |
否 |
String |
模块相关信息 |
|
module_type |
否 |
String |
模块类型,tab/section |
|
metric_ids |
否 |
String |
section类模块关联的指标id |
|
thumbnail |
否 |
String |
模块缩略图 |
|
data_query |
否 |
String |
数据查询方式 |
|
boa_version |
否 |
String |
BOA底座版本 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为：request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
message |
String |
错误信息 |
|
request_id |
String |
请求ID |
|
success |
Boolean |
请求结果 |
|
data |
ModuleDetailInfo object |
模块详情 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
cloud_pack_id |
String |
订阅包id |
|
cloud_pack_name |
String |
订阅包名称 |
|
cloud_pack_version |
String |
订阅包版本 |
|
create_time |
String |
创建时间 |
|
creator_id |
String |
创建者ID |
|
description |
String |
描述信息 |
|
en_description |
String |
英文描述 |
|
id |
String |
模块ID |
|
module_json |
String |
模块相关信息，当module为指标卡片时，items中的字段id也为指标id |
|
name |
String |
名称 |
|
en_name |
String |
英文名称 |
|
project_id |
String |
租户ID |
|
workspace_id |
String |
工作空间ID |
|
update_time |
String |
更新时间 |
|
thumbnail |
String |
模块缩略图 |
|
module_type |
String |
模块类型,tab/section |
|
tag |
String |
模块标签 |
|
is_built_in |
Boolean |
是否为系统模块 |
|
data_query |
String |
数据查询方式 |
|
boa_version |
String |
BOA底座版本 |
|
version |
String |
安全云脑版本 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为：request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 错误码 取值范围: 不涉及 |
|
message |
String |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
创建模块请求体
{
"workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca620",
"thumbnail" : "xxxxxx",
"project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"module_type" : "tab",
"name" : "MyModule4",
"description" : "This my XXXX",
"metric_ids" : "123",
"id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"module_json" : "{\"items\":[{\"dataclass_name\":\"指标\",\"case_sensitived\":false,\"cloud_pack_id\":\"\",\"cloud_pack_name\":\"\",\"cloud_pack_version\":\"\",\"is_built_in\":false,\"creatable\":null,\"create_time\":\"2022-03-15T10:39:09Z+0800\",\"creator_id\":\"\",\"creator_name\":\"\",\"default_value\":\"XXXXXXXXXXXX\",\"en_default_value\":\"\",\"description\":\"\",\"en_description\":\"\",\"display_type\":\"pie\",\"editable\":null,\"extra_json\":\"{\"x-label\":\"time\",\"y-label\":\"value\",\"api\":\"/xxxx/\"}\",\"field_key\":\"XXXXXXX\",\"name\":\"XXXXXX\",\"en_name\":\"\",\"field_tooltip\":\"\",\"field_type\":\"pie\",\"id\":\"21d729b8-2fa4-4e61-82ef-c7fa4bff02ef\",\"iu_type\":null,\"json_schema\":\"\",\"maintainable\":null,\"modifier_id\":\"\",\"modifier_name\":\"\",\"readonly\":false,\"required\":false,\"searchable\":false,\"update_time\":\"2022-03-15T10:39:09Z+0800\",\"used_by\":\"securityreport\",\"visible\":true}]}"
}
响应示例
状态码：200
创建模块返回信息
{
"code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"message" : "Error message",
"success" : true,
"data" : {
"boa_version" : "v3",
"cloud_pack_id" : "cloud",
"cloud_pack_name" : "cloud",
"cloud_pack_version" : "v1",
"data_query" : null,
"description" : "This my XXXX",
"en_description" : "This my XXXX",
"en_name" : "test",
"id" : "a2a6a89e-07cf-413c-a823-94a073239b2d",
"is_built_in" : null,
"module_json" : "eyJpdGVtcyI6W3siZGF0YWNsYXNzX25hbWUiOiLmjIfmoIciLCJjYXNlX3NlbnNpdGl2ZWQiOmZhbHNlLCJjbG91ZF9wYWNrX2lkIjoiIiwiY2xvdWRfcGFja19uYW1lIjoiIiwiY2xvdWRfcGFja192ZXJzaW9uIjoiIiwiaXNfYnVpbHRfaW4iOmZhbHNlLCJjcmVhdGFibGUiOm51bGwsImNyZWF0ZV90aW1lIjoiMjAyMi0wMy0xNVQxMDozOTowOVorMDgwMCIsImNyZWF0b3JfaWQiOiIiLCJjcmVhdG9yX25hbWUiOiIiLCJkZWZhdWx0X3ZhbHVlIjoiWFhYWFhYWFhYWFhYIiwiZW5fZGVmYXVsdF92YWx1ZSI6IiIsImRlc2NyaXB0aW9uIjoiIiwiZW5fZGVzY3JpcHRpb24iOiIiLCJkaXNwbGF5X3R5cGUiOiJwaWUiLCJlZGl0YWJsZSI6bnVsbCwiZXh0cmFfanNvbiI6InsieC1sYWJlbCI6InRpbWUiLCJ5LWxhYmVsIjoidmFsdWUiLCJhcGkiOiIveHh4eC8ifSIsImZpZWxkX2tleSI6IlhYWFhYWFgiLCJuYW1lIjoiWFhYWFhYIiwiZW5fbmFtZSI6IiIsImZpZWxkX3Rvb2x0aXAiOiIiLCJmaWVsZF90eXBlIjoicGllIiwiaWQiOiIyMWQ3MjliOC0yZmE0LTRlNjEtODJlZi1jN2ZhNGJmZjAyZWYiLCJpdV90eXBlIjpudWxsLCJqc29uX3NjaGVtYSI6IiIsIm1haW50YWluYWJsZSI6bnVsbCwibW9kaWZpZXJfaWQiOiIiLCJtb2RpZmllcl9uYW1lIjoiIiwicmVhZG9ubHkiOmZhbHNlLCJyZXF1aXJlZCI6ZmFsc2UsInNlYXJjaGFibGUiOmZhbHNlLCJ1cGRhdGVfdGltZSI6IjIwMjItMDMtMTVUMTA6Mzk6MDlaKzA4MDAiLCJ1c2VkX2J5Ijoic2VjdXJpdHlyZXBvcnQiLCJ2aXNpYmxlIjp0cnVlfV19",
"module_type" : "tab",
"name" : "MyModule4",
"project_id" : "81fee81ab75a48a7b38e6586868688e7",
"tag" : "test",
"thumbnail" : "xxxxxx",
"version" : "25.2.0",
"workspace_id" : "8ace3994-5fab-429b-ae44-9b4307c5b694"
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
创建模块返回信息 |
|
400 |
错误响应 |
错误码
请参见错误码。
