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

获取ES索引的字段列表

功能介绍

根据Elasticsearch的索引和类型获取字段列表

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

db_id

String

ES资产的唯一ID

index

String

Elasticsearch索引名称

sequence

String

Elasticsearch索引的排序字段

type

String

Elasticsearch索引下的type名称

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

fields

Array of ESFieldInfo objects

Elasticsearch字段的详细信息列表

表4 ESFieldInfo

参数

参数类型

描述

classification_name

String

字段分类的名称

data_type

String

字段的数据类型

field_name

String

字段的名称

level

Integer

字段的敏感级别

rule_id

String

字段对应的脱敏规则的唯一ID

rule_name

String

字段对应的脱敏规则的名称

状态码:201

资源创建

请求示例

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

{
  "db_id" : "string",
  "index" : "string",
  "sequence" : "string",
  "type" : "string"
}

响应示例

状态码

状态码

描述

200

查询结果

201

资源创建

401

未授权

403

禁止访问

404

资源未找到

错误码

请参见错误码

相关文档