Obtaining the Field List of the Elasticsearch Index

Function

This API is used to obtain the field list of the Elasticsearch index and type.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Unique project ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
db_id	No	String	Unique ID of the Elasticsearch asset.
index	No	String	Specifies the Elasticsearch index name.
sequence	No	String	Specifies the sorting field of the Elasticsearch index.
type	No	String	Specifies the type name under the Elasticsearch index.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
fields	Array of ESFieldInfo objects	Elasticsearch field details

**Table 4** ESFieldInfo
Parameter	Type	Description
classification_name	String	Field category name
data_type	String	Field data type.
field_name	String	Field name
level	Integer	Field sensitivity level.
rule_id	String	Unique ID of the masking rule corresponding to the field.
rule_name	String	Name of the masking rule corresponding to the field.

Status code: 201

Resource creation.

Example Requests

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

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