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

获取es的列 - CreateFields

功能介绍

获取es的列

调用方法

请参见如何调用API。

授权信息

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

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

URI

POST /v1/{project_id}/sdg/server/mask/bigdata/es/indexes/types/fields

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

db_id

否

String

参数解释：

数据库ID

约束限制：

最大长度1024字符

取值范围：

不涉及

默认取值：

不涉及

index

否

String

参数解释：

索引

约束限制：

最大长度1024字符

取值范围：

不涉及

默认取值：

不涉及

type

否

String

参数解释：

类型

约束限制：

最大长度1024字符

取值范围：

不涉及

默认取值：

不涉及

sequence

否

String

参数解释：

序列

约束限制：

最大长度1024字符

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

fields

Array of ESFieldInfo objects

参数解释：

ES字段信息列表

取值范围：

不涉及
表5 ESFieldInfo

参数

参数类型

描述

field_name

String

参数解释：

ES字段名称

取值范围：

不涉及

data_type

String

参数解释：

ES字段数据类型

取值范围：

不涉及

level

Integer

参数解释：

字段敏感等级

取值范围：

不涉及

classification_name

String

参数解释：

分类分级名称

取值范围：

不涉及

rule_name

String

参数解释：

规则名称

取值范围：

不涉及

rule_id

String

参数解释：

匹配规则标识

取值范围：

不涉及

请求示例

获取es的列

{
  "db_id" : "0b02392f3d0042bd8f80376485d9b7d8",
  "index" : "1",
  "type" : "default-value",
  "sequence" : "1"
}

响应示例

状态码：200

{
  "fields" : [ {
    "field_name" : "customer_phone",
    "data_type" : "text",
    "level" : 3,
    "classification_name" : "个人敏感信息",
    "rule_name" : "手机号识别规则",
    "rule_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c"
  } ]
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

父主题： 数据脱敏

相关文档