Modifying Indexes

Function

This API is used to modify indexes.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/workspaces/{workspace_id}/siem/pipes/{pipe_id}/index

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Value Range N/A Default value N/A
workspace_id	Yes	String	Workspace ID.
pipe_id	Yes	String	Pipeline ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
-	Yes	Object	Request body for updating indexes.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
mapping	Map<String,KeyIndex>	Index mapping information.
pipe_id	String	Data pipeline ID.
status	String	Index status. The value can be open or closed.
timestamp_field	String	Timestamp field name.

**Table 5** KeyIndex
Parameter	Type	Description
is_chinese_exist	Boolean	Whether non-English characters are contained.
properties	Map<String,KeyIndex>	Nested structure.
type	String	Definition Field type. text: full-text index field keyword: keyword type, which is used for exact match. long: long integer integer: integer double: double-precision floating point float: single-precision floating point date: date type Constraints N/A Range text keyword long integer double float date Default Value N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

None

Example Responses

Status code: 200

Successful.

{
  "mapping" : {
    "key1" : {
      "type" : "keyword"
    },
    "key2" : {
      "properties" : {
        "key3" : {
          "is_chinese_exist" : true,
          "type" : "text"
        },
        "key4" : {
          "type" : "long"
        }
      }
    }
  },
  "pipe_id" : "b22106ba-bede-453c-8488-b60c70bd6aed",
  "status" : "closed",
  "timestamp_field" : "timestamp"
}