获取ES索引的字段列表 - ListESField

功能介绍

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

调用方法

请参见如何调用API。

授权信息

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

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

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目唯一标识符

请求参数

表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"
}