文档首页/ 安全云脑 SecMaster/ API参考/ 安全云脑 API V2/ 表管理/ 更改表详情 - UpdateTable

更新时间：2026-01-29 GMT+08:00

在线调试

CLI示例

查看PDF

更改表详情 - UpdateTable

功能介绍

更改表详情

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取项目ID 约束限制：不涉及取值范围：不涉及默认取值：不涉及
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	错误描述

请求示例

表详情新增描述"add_description"

https://{endpoint}/v2/{project_id}/workspaces/{workspace_id}/siem/tables/{table_id}

{
  "description" : "add_description"
}

响应示例

状态码：200

成功

{
  "category" : "STREAMING",
  "create_time" : 1767941191174,
  "data_classification" : "FACTUAL_DATA",
  "data_layering" : "ODS",
  "delete_time" : 0,
  "description" : "add_description",
  "directory" : "",
  "display_setting" : {
    "columns" : [ {
      "column_alias" : "",
      "column_name" : "test_update",
      "display_by_default" : true
    }, {
      "column_alias" : "",
      "column_name" : "test_timestamp",
      "display_by_default" : true
    }, {
      "column_alias" : "",
      "column_name" : "test_add_column",
      "display_by_default" : true
    } ],
    "format" : "TABLE"
  },
  "format" : "JSON",
  "lock_status" : "UNLOCKED",
  "owner_type" : "USER",
  "process_error" : "NONE",
  "process_status" : "COMPLETED",
  "project_id" : "f69081793d9e4ea8a2f479dcef961989",
  "rw_type" : "READ_WRITE",
  "schema" : {
    "columns" : [ {
      "array" : false,
      "column_data_type" : "INT",
      "column_data_type_setting" : "",
      "column_name" : "test_update",
      "column_sequence_number" : 0,
      "column_type" : "PHYSICAL",
      "column_type_setting" : "",
      "depth" : 0,
      "nullable" : true,
      "own_name" : "test_update",
      "parent_name" : ""
    }, {
      "array" : false,
      "column_data_type" : "TIMESTAMP",
      "column_data_type_setting" : "3",
      "column_name" : "test_timestamp",
      "column_sequence_number" : 0,
      "column_type" : "PHYSICAL",
      "column_type_setting" : "",
      "depth" : 0,
      "nullable" : false,
      "own_name" : "test_timestamp",
      "parent_name" : ""
    }, {
      "array" : false,
      "column_data_type" : "STRING",
      "column_data_type_setting" : "",
      "column_name" : "test_add_column",
      "column_sequence_number" : 0,
      "column_type" : "PHYSICAL",
      "column_type_setting" : "",
      "depth" : 0,
      "nullable" : false,
      "own_name" : "test_add_column",
      "parent_name" : ""
    } ],
    "partition" : [ ],
    "primary_key" : [ ],
    "time_filter" : "test_timestamp",
    "watermark_column" : "test_timestamp",
    "watermark_interval" : 6.0
  },
  "storage_setting" : {
    "streaming_bandwidth" : 5.0,
    "streaming_dataspace_id" : "153e3cb7-b8eb-40bc-a21a-11a8fe86afd7",
    "streaming_partition" : 1,
    "streaming_retention_size" : 1024
  },
  "table_alias" : "123",
  "table_id" : "5fd42918-2ff1-4b2b-be2a-4eb3077230e0",
  "table_name" : "s_test_update",
  "update_time" : 1767943009375,
  "workspace_id" : "885f11d0-256b-4f62-b494-1c1f8822a705"
}

SDK代码示例

SDK代码示例如下。

      
       
         
         
           package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.secmaster.v2.region.SecMasterRegion;
import com.huaweicloud.sdk.secmaster.v2.*;
import com.huaweicloud.sdk.secmaster.v2.model.*;


public class UpdateTableSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        SecMasterClient client = SecMasterClient.newBuilder()
                .withCredential(auth)
                .withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateTableRequest request = new UpdateTableRequest();
        request.withWorkspaceId("{workspace_id}");
        request.withTableId("{table_id}");
        try {
            UpdateTableResponse response = client.updateTable(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

          

        

      
     

      
       
         
         
           # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksecmaster.v2.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = SecMasterClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateTableRequest()
        request.workspace_id = "{workspace_id}"
        request.table_id = "{table_id}"
        response = client.update_table(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

      
       
         
         
           package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := secmaster.NewSecMasterClient(
        secmaster.SecMasterClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateTableRequest{}
	request.WorkspaceId = "{workspace_id}"
	request.TableId = "{table_id}"
	response, err := client.UpdateTable(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码	描述
200	成功
400	错误响应

错误码

请参见错误码。

父主题：表管理

上一篇：获取表详情 - ShowTable

下一篇：删除表 - DeleteTable

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问