更新时间:2025-08-30 GMT+08:00
分享

更改表详情

功能介绍

更改表详情

调用方法

请参见如何调用API

URI

PUT /v2/{project_id}/workspaces/{workspace_id}/siem/tables/{table_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及w

默认取值:

不涉及

workspace_id

String

工作空间ID

table_id

String

表ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

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

表展示设置数据传输对象

表4 IsapTableStorageSettingDto

参数

是否必选

参数类型

描述

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

参数解释:

数据湖定时分区设置

  • MINUTE10 10分钟

  • HOUR 小时

  • DAY 天

约束限制

不涉及

取值范围:

  • MINUTE

  • HOUR

  • DAY

默认值

不涉及

表5 IsapTableDisplaySettingDto

参数

是否必选

参数类型

描述

columns

Array of IsapTableColumnDisplaySettingDto objects

表格列展示列表

format

String

参数解释:

表展示设置

  • TABLE 表展示

  • RAW 原始数据展示

约束限制

不涉及

取值范围:

  • TABLE

  • RAW

默认值

不涉及

表6 IsapTableColumnDisplaySettingDto

参数

是否必选

参数类型

描述

column_name

String

表格列名称

column_alias

String

表格列别名

column_alias_en

String

表格列别名

display_by_default

Boolean

是否默认展示

响应参数

状态码:200

表7 响应Body参数

参数

参数类型

描述

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

参数解释:

目录类型

  • STREAMING 实时流

  • INDEX 索引

  • APPLICATION 应用

  • TENANT_BUCKET 租户桶

  • LAKE 数据湖

约束限制

不涉及

取值范围:

  • STREAMING

  • INDEX

  • APPLICATION

  • TENANT_BUCKET

  • LAKE

默认值

不涉及

lock_status

String

参数解释:

表锁状态

  • LOCKED 已锁

  • UNLOCKED 未锁

约束限制

不涉及

取值范围:

  • LOCKED

  • UNLOCKED

默认值

不涉及

process_status

String

参数解释:

处理状态

  • COMPLETED 已完成

  • CREATING 创建中

  • UPDATING 更新中

  • DELETING 删除中

  • TRUNCATING 清空中

  • UPGRADING 升级中

  • CREATE_FAILED 创建失败

  • UPDATE_FAILED 更新失败

  • DELETE_FAILED 删除失败

  • TRUNCATE_FAILED 清空失败

  • UPGRADE_FAILED 升级失败

约束限制

不涉及

取值范围:

  • COMPLETED

  • CREATING

  • UPDATING

  • DELETING

  • TRUNCATING

  • UPGRADING

  • CREATE_FAILED

  • UPDATE_FAILED

  • DELETE_FAILED

  • TRUNCATE_FAILED

  • UPGRADE_FAILED

默认值

不涉及

process_error

String

参数解释:

表处理错误

  • NONE 无

  • MISSING_ASSOCIATIONS 关联缺失

  • FAILED_INIT_STORAGE_RESOURCES_WHEN_CREATING 创建时初始化存储资源失败

  • FAILED_INIT_FLINK_RESOURCES_WHEN_CREATING 创建时初始化 Flink 资源失败

  • FAILED_DELETE_FLINK_RESOURCES_WHEN_DELETING 删除时删除 Flink 资源失败

  • FAILED_DELETE_STORAGE_RESOURCES_WHEN_DELETING 删除时删除存储资源失败

  • FAILED_DELETE_ALL_RESOURCES_WHEN_DELETING 删除时删除所有资源失败

  • FAILED_UPDATE_STORAGE_SETTING 更新存储配置失败

  • FAILED_UPDATE_FLINK_SCHEMA 更新 Flink 模式失败

  • FAILED_UPDATE_STORAGE_SCHEMA 更新存储模式失败

  • FAILED_TO_APPLY_RESOURCE 应用资源失败

  • FAILED_TO_UPGRADE_RESOURCE_MODEL 升级资源模型失败

约束限制

不涉及

取值范围:

  • NONE

  • MISSING_ASSOCIATIONS

  • FAILED_INIT_STORAGE_RESOURCES_WHEN_CREATING

  • FAILED_INIT_FLINK_RESOURCES_WHEN_CREATING

  • FAILED_DELETE_FLINK_RESOURCES_WHEN_DELETING

  • FAILED_DELETE_STORAGE_RESOURCES_WHEN_DELETING

  • FAILED_DELETE_ALL_RESOURCES_WHEN_DELETING

  • FAILED_UPDATE_STORAGE_SETTING

  • FAILED_UPDATE_FLINK_SCHEMA

  • FAILED_UPDATE_STORAGE_SCHEMA

  • FAILED_TO_APPLY_RESOURCE

  • FAILED_TO_UPGRADE_RESOURCE_MODEL

默认值

不涉及

format

String

参数解释:

表格式

  • JSON Json格式

  • DEBEZIUM_JSON Debezium JSON 格式

  • CSV CSV格式

  • PARQUET PARQUET格式

  • ORC ORC格式

约束限制

不涉及

取值范围:

  • JSON

  • DEBEZIUM_JSON

  • CSV

  • PARQUET

  • ORC

默认值

不涉及

rw_type

String

参数解释:

表读写类型

  • READ_ONLY 只读

  • READ_WRITE 读写

  • WRITE_ONLY 只写

约束限制

不涉及

取值范围:

  • READ_ONLY

  • READ_WRITE

  • WRITE_ONLY

默认值

不涉及

owner_type

String

参数解释:

拥有者类型

  • SYSTEM 系统

  • USER 用户

  • SYSTEM_ALLOWED_DELETE 系统可删除

  • USER_ALLOWED_DELETE 用户可删除

约束限制

不涉及

取值范围:

  • SYSTEM

  • USER

  • SYSTEM_ALLOWED_DELETE

  • USER_ALLOWED_DELETE

默认值

不涉及

data_layering

String

参数解释:

数据分层

  • ODS 操作数据存储层

  • DWS 数据汇总层

  • ADS 应用数据服务层

约束限制

不涉及

取值范围:

  • ODS

  • DWS

  • ADS

默认值

不涉及

data_classification

String

参数解释:

数据分类

  • FACTUAL_DATA 事实数据

  • DIMENSION_DATA 维度数据

约束限制

不涉及

取值范围:

  • FACTUAL_DATA

  • DIMENSION_DATA

默认值

不涉及

schema

IsapTableSchema object

表架构

storage_setting

TableStorageSetting object

表存储设置

display_setting

TableDisplaySetting object

表展示设置

create_time

Integer

毫秒时间戳

update_time

Integer

毫秒时间戳

delete_time

Integer

毫秒时间戳

表8 IsapTableSchema

参数

参数类型

描述

columns

Array of IsapTableColumn objects

表格列列表

primary_key

Array of strings

表主键列表

partition

Array of strings

表分区列表

watermark_column

String

表水位列元素

watermark_interval

Float

表水位延迟间隔

time_filter

String

表时间过滤列

表9 IsapTableColumn

参数

参数类型

描述

column_name

String

表格列名称

column_type

String

参数解释:

列字段类型

  • PHYSICAL 物理字段

  • METADATA 元数据字段

  • VIRTUAL_METADATA 虚拟元数据字段

  • COMPUTED 计算字段

约束限制

不涉及

取值范围:

  • PHYSICAL

  • METADATA

  • VIRTUAL_METADATA

  • COMPUTED

默认值

不涉及

column_type_setting

String

表格列类型设置

column_data_type

String

参数解释:

列字段数据类型

  • ROW 行类型

  • MAP_STRING 字符串映射类型

  • MAP_DECIMAL 小数映射类型

  • TINYINT 微整型

  • SMALLINT 小整型

  • INT 整型

  • BIGINT 长整型

  • DECIMAL 精确小数类型

  • FLOAT 单精度浮点数

  • DOUBLE 双精度浮点数

  • CHAR 定长字符串

  • VARCHAR 不定长字符串

  • STRING 字符串类型

  • KEYWORD 关键字类型

  • BOOLEAN 布尔类型

  • DATE 日期类型

  • TIME 事件类型

  • TIMESTAMP 时间戳类型

  • TIMESTAMP_LTZ 本地时间戳类型

约束限制

不涉及

取值范围:

  • ROW

  • MAP_STRING

  • MAP_DECIMAL

  • TINYINT

  • SMALLINT

  • INT

  • BIGINT

  • DECIMAL

  • FLOAT

  • DOUBLE

  • CHAR

  • VARCHAR

  • STRING

  • KEYWORD

  • BOOLEAN

  • DATE

  • TIME

  • TIMESTAMP

  • TIMESTAMP_LTZ

默认值

不涉及

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

列序号

表10 ColumnDisplaySetting

参数

参数类型

描述

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

组名

表11 TableStorageSetting

参数

参数类型

描述

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

参数解释:

时间单位

  • MINUTE10 10分钟

  • HOUR 小时

  • DAY 天

约束限制

不涉及

取值范围:

  • MINUTE

  • HOUR

  • DAY

默认值

不涉及

lake_expiration_status

String

参数解释:

数据湖过期状态

  • NOT_EXPIRED 未过期

  • EXPIRED_PROCESSING 过期处理中

  • EXPIRED_SUCCESS 过期处理成功

  • EXPIRED_FAILURE 过期处理失败

约束限制

不涉及

取值范围:

  • NOT_EXPIRED

  • EXPIRED_PROCESSING

  • EXPIRED_SUCCESS

  • EXPIRED_FAILURE

默认值

不涉及

表12 TableDisplaySetting

参数

参数类型

描述

columns

Array of TableColumnDisplaySetting objects

表格列展示列表

format

String

参数解释:

表展示设置

  • TABLE 表展示

  • RAW 原始数据展示

约束限制

不涉及

取值范围:

  • TABLE

  • RAW

默认值

不涉及

表13 TableColumnDisplaySetting

参数

参数类型

描述

column_name

String

表格列名称

column_alias

String

表格列别名

display_by_default

Boolean

是否默认展示

状态码:400

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

响应示例

状态码

状态码

描述

200

Response of show table

400

Error response

错误码

请参见错误码

相关文档