文档首页/ 数据安全中心 DSC/ API参考/ API/ 数据脱敏/ 获取数据库列的列表 - CreateColumns
更新时间：2026-10-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取数据库列的列表 - CreateColumns

功能介绍

获取数据库列的列表

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v1/{project_id}/sdg/server/mask/dbs/rdbs/tables/columns

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。可参考获取项目ID获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-32，满足正则匹配"^[a-z0-9]{32}$"

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

type

是

String

参数解释：

类型

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及

取值范围：

IAM服务查询用户Token接口为准

默认取值：

不涉及
表4 请求Body参数

参数

是否必选

参数类型

描述

db_id

否

String

参数解释：

数据库ID

约束限制：

最大长度1024字符

取值范围：

不涉及

默认取值：

不涉及

db_name

否

String

参数解释：

数据库名称

约束限制：

最大长度1024字符

取值范围：

不涉及

默认取值：

不涉及

schema

否

String

参数解释：

模式

约束限制：

最大长度1024字符

取值范围：

不涉及

默认取值：

不涉及

table_name

否

String

参数解释：

表名称

约束限制：

最大长度1024字符

取值范围：

不涉及

默认取值：

不涉及

sequence

否

String

参数解释：

序列

约束限制：

最大长度1024字符

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

column

Array of RdbColumn objects

参数解释：

列信息列表列表

取值范围：

不涉及

partition_info

Object

参数解释：

分区信息

取值范围：

不涉及

classification_name

String

参数解释：

分类名称

取值范围：

不涉及

column_name

String

参数解释：

列名

取值范围：

不涉及

data_type

String

参数解释：

数据类型

取值范围：

不涉及

level

Integer

参数解释：

级别

取值范围：

不涉及

rule_id

String

参数解释：

规则ID

取值范围：

不涉及

rule_name

String

参数解释：

规则名称

取值范围：

不涉及
表6 RdbColumn

参数

参数类型

描述

column_name

String

参数解释：

列名

取值范围：

不涉及

data_type

String

参数解释：

字段数据类型

取值范围：

不涉及

level

Integer

参数解释：

敏感等级

取值范围：

不涉及

classification_name

String

参数解释：

分类名称

取值范围：

不涉及

rule_name

String

参数解释：

规则名称

取值范围：

不涉及

rule_id

String

参数解释：

规则ID

取值范围：

不涉及

请求示例

获取数据库列的列表

{
  "db_id" : "0b02392f3d0042bd8f80376485d9b7d8",
  "db_name" : "db-finance-01",
  "schema" : "example-schema",
  "table_name" : "table-finance-01",
  "sequence" : "1"
}

响应示例

状态码：200

{
  "column" : [ {
    "column_name" : "字段1",
    "data_type" : "varchar",
    "level" : 1,
    "classification_name" : "分类1",
    "rule_name" : "规则1",
    "rule_id" : "00000000-0000-0000-0000-000000000000"
  } ],
  "partition_info" : { }
}

状态码

状态码

描述

200

操作成功

错误码

请参见错误码。

父主题： 数据脱敏

相关文档