更新布局模块
功能介绍
更新模块
调用方法
请参见如何调用API。
URI
PUT /v1/{project_id}/workspaces/{workspace_id}/soc/modules/{module_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
workspace_id |
是 |
String |
参数解释: 工作空间id。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
module_id |
是 |
String |
模块ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
content-type |
是 |
String |
参数解释: 内容类型
约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
cloud_pack_id |
否 |
String |
订阅包id |
cloud_pack_name |
否 |
String |
订阅包名称 |
cloud_pack_version |
否 |
String |
订阅包版本 |
description |
否 |
String |
描述 |
module_json |
否 |
String |
布局模块相关信息 |
name |
是 |
String |
名称 |
update_time |
否 |
String |
更新时间 |
thumbnail |
否 |
String |
模块缩略图 |
module_type |
否 |
String |
模块类型,tab/section |
metric_ids |
否 |
String |
section类模块关联的指标id |
data_query |
否 |
String |
数据查询方式 |
boa_version |
否 |
String |
BOA底座版本 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname |
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
错误码 |
message |
String |
错误信息 |
request_id |
String |
Request id |
success |
Boolean |
请求结果 |
data |
ModuleDetailInfo object |
模块详情 |
参数 |
参数类型 |
描述 |
---|---|---|
cloud_pack_id |
String |
订阅包id |
cloud_pack_name |
String |
订阅包名称 |
cloud_pack_version |
String |
订阅包版本 |
create_time |
String |
Create time |
creator_id |
String |
Creator id value |
description |
String |
描述信息 |
en_description |
String |
英文描述 |
id |
String |
IID |
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 |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
无
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
更新模块响应 |
400 |
错误响应 |
错误码
请参见错误码。