更改表详情
功能介绍
更改表详情
调用方法
请参见如何调用API。
URI
PUT /v2/{project_id}/workspaces/{workspace_id}/siem/tables/{table_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及w 默认取值: 不涉及 |
workspace_id |
是 |
String |
工作空间ID |
table_id |
是 |
String |
表ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
table_alias |
否 |
String |
表别名 |
table_alias_en |
否 |
String |
表别名 |
table_alias_fr |
否 |
String |
表别名 |
description |
否 |
String |
表相关描述 |
description_en |
否 |
String |
表相关描述 |
description_fr |
否 |
String |
表相关描述 |
directory |
否 |
String |
目录分组 |
directory_en |
否 |
String |
目录分组 |
directory_fr |
否 |
String |
目录分组 |
storage_setting |
否 |
IsapTableStorageSettingDto object |
表存储设置数据传输对象 |
display_setting |
否 |
IsapTableDisplaySettingDto object |
表展示设置数据传输对象 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
application_index |
否 |
String |
应用索引 |
application_topic |
否 |
String |
应用主题 |
application_data_class_id |
否 |
String |
应用数据类ID |
streaming_bandwidth |
否 |
Number |
流式带宽 MB/s |
streaming_partition |
否 |
Integer |
流式分区 |
streaming_dataspace_id |
否 |
String |
流式数据空间ID |
index_storage_period |
否 |
Integer |
索引存储周期 |
index_storage_size |
否 |
Integer |
索引存储大小 |
index_shards |
否 |
Integer |
索引分片数 |
lake_storage_period |
否 |
Long |
数据湖存储周期 |
lake_partition_setting |
否 |
String |
参数解释: 数据湖定时分区设置
约束限制 不涉及 取值范围:
默认值 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
columns |
否 |
Array of IsapTableColumnDisplaySettingDto objects |
表格列展示列表 |
format |
否 |
String |
参数解释: 表展示设置
约束限制 不涉及 取值范围:
默认值 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
project_id |
String |
项目ID |
workspace_id |
String |
工作空间ID |
table_id |
String |
UUID |
pipe_id |
String |
UUID |
table_name |
String |
表名称 |
table_alias |
String |
表别名 |
description |
String |
相关描述 |
directory |
String |
directory 目录分组 |
category |
String |
参数解释: 目录类型
约束限制 不涉及 取值范围:
默认值 不涉及 |
lock_status |
String |
参数解释: 表锁状态
约束限制 不涉及 取值范围:
默认值 不涉及 |
process_status |
String |
参数解释: 处理状态
约束限制 不涉及 取值范围:
默认值 不涉及 |
process_error |
String |
参数解释: 表处理错误
约束限制 不涉及 取值范围:
默认值 不涉及 |
format |
String |
参数解释: 表格式
约束限制 不涉及 取值范围:
默认值 不涉及 |
rw_type |
String |
参数解释: 表读写类型
约束限制 不涉及 取值范围:
默认值 不涉及 |
owner_type |
String |
参数解释: 拥有者类型
约束限制 不涉及 取值范围:
默认值 不涉及 |
data_layering |
String |
参数解释: 数据分层
约束限制 不涉及 取值范围:
默认值 不涉及 |
data_classification |
String |
参数解释: 数据分类
约束限制 不涉及 取值范围:
默认值 不涉及 |
schema |
IsapTableSchema object |
表架构 |
storage_setting |
TableStorageSetting object |
表存储设置 |
display_setting |
TableDisplaySetting object |
表展示设置 |
create_time |
Integer |
毫秒时间戳 |
update_time |
Integer |
毫秒时间戳 |
delete_time |
Integer |
毫秒时间戳 |
参数 |
参数类型 |
描述 |
---|---|---|
columns |
Array of IsapTableColumn objects |
表格列列表 |
primary_key |
Array of strings |
表主键列表 |
partition |
Array of strings |
表分区列表 |
watermark_column |
String |
表水位列元素 |
watermark_interval |
Float |
表水位延迟间隔 |
time_filter |
String |
表时间过滤列 |
参数 |
参数类型 |
描述 |
---|---|---|
column_name |
String |
表格列名称 |
column_type |
String |
参数解释: 列字段类型
约束限制 不涉及 取值范围:
默认值 不涉及 |
column_type_setting |
String |
表格列类型设置 |
column_data_type |
String |
参数解释: 列字段数据类型
约束限制 不涉及 取值范围:
默认值 不涉及 |
column_data_type_setting |
String |
表格列数据类型设置 |
nullable |
Boolean |
是否为空 |
array |
Boolean |
是否为数组 |
depth |
Integer |
深度 |
parent_name |
String |
父级名称 |
own_name |
String |
所属名称 |
column_display_setting |
ColumnDisplaySetting object |
表格列展示设置 |
column_sequence_number |
Integer |
列序号 |
参数 |
参数类型 |
描述 |
---|---|---|
mapping_required |
Boolean |
映射是否必填 |
group_sequence_number |
Integer |
组顺序编号 |
intra_group_sequence_number |
Integer |
组内顺序编号 |
value_type |
String |
值类型 |
value_qualified |
String |
合法值 |
display_name |
String |
显示名称 |
display_description |
String |
显示描述 |
group_name |
String |
组名 |
参数 |
参数类型 |
描述 |
---|---|---|
application_index |
String |
应用索引 |
application_topic |
String |
应用主题 |
application_data_class_id |
String |
应用数据类ID |
streaming_bandwidth |
Number |
流式带宽 MB/s |
streaming_partition |
Integer |
流式分区 |
streaming_retention_size |
Integer |
流式容量大小 |
streaming_dataspace_id |
String |
流式数据空间ID |
index_storage_period |
Integer |
索引存储周期 |
index_storage_size |
Integer |
索引存储大小 |
index_shards |
Integer |
索引分片数 |
index_replicas |
Integer |
索引副本数 |
lake_storage_period |
Long |
数据湖存储周期 |
lake_partition_setting |
String |
参数解释: 时间单位
约束限制 不涉及 取值范围:
默认值 不涉及 |
lake_expiration_status |
String |
参数解释: 数据湖过期状态
约束限制 不涉及 取值范围:
默认值 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
columns |
Array of TableColumnDisplaySetting objects |
表格列展示列表 |
format |
String |
参数解释: 表展示设置
约束限制 不涉及 取值范围:
默认值 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
column_name |
String |
表格列名称 |
column_alias |
String |
表格列别名 |
display_by_default |
Boolean |
是否默认展示 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
无
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
Response of show table |
400 |
Error response |
错误码
请参见错误码。