Updated on 2026-02-05 GMT+08:00

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

mapping

Yes

Map<String,KeyIndex>

Index mapping information.

pipe_id

Yes

String

Data pipeline ID.

status

Yes

String

Index status. The value can be open or closed.

timestamp_field

Yes

String

Timestamp field name.

Table 4 KeyIndex

Parameter

Mandatory

Type

Description

is_chinese_exist

No

Boolean

Whether non-English characters are contained.

properties

No

Map<String,KeyIndex>

Nested structure.

type

No

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

Response Parameters

Status code: 200

Table 5 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 6 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 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

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

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

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.secmaster.v1.region.SecMasterRegion;
import com.huaweicloud.sdk.secmaster.v1.*;
import com.huaweicloud.sdk.secmaster.v1.model.*;

import java.util.Map;
import java.util.HashMap;

public class UpdatePipeIndexSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        SecMasterClient client = SecMasterClient.newBuilder()
                .withCredential(auth)
                .withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdatePipeIndexRequest request = new UpdatePipeIndexRequest();
        request.withWorkspaceId("{workspace_id}");
        request.withPipeId("{pipe_id}");
        UpdateIndexRequestBody body = new UpdateIndexRequestBody();
        KeyIndex propertiesProperties = new KeyIndex();
        propertiesProperties.withType(KeyIndex.TypeEnum.fromValue("long"));
        KeyIndex propertiesProperties1 = new KeyIndex();
        propertiesProperties1.withIsChineseExist(true)
            .withType(KeyIndex.TypeEnum.fromValue("text"));
        Map<String, KeyIndex> listMappingProperties = new HashMap<>();
        listMappingProperties.put("key3", propertiesProperties1);
        listMappingProperties.put("key4", propertiesProperties);
        KeyIndex mappingMapping = new KeyIndex();
        mappingMapping.withProperties(listMappingProperties);
        KeyIndex mappingMapping1 = new KeyIndex();
        mappingMapping1.withType(KeyIndex.TypeEnum.fromValue("keyword"));
        Map<String, KeyIndex> listbodyMapping = new HashMap<>();
        listbodyMapping.put("key1", mappingMapping1);
        listbodyMapping.put("key2", mappingMapping);
        body.withTimestampField("timestamp");
        body.withStatus(UpdateIndexRequestBody.StatusEnum.fromValue("closed"));
        body.withPipeId("b22106ba-bede-453c-8488-b60c70bd6aed");
        body.withMapping(listbodyMapping);
        request.withBody(body);
        try {
            UpdatePipeIndexResponse response = client.updatePipeIndex(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = SecMasterClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdatePipeIndexRequest()
        request.workspace_id = "{workspace_id}"
        request.pipe_id = "{pipe_id}"
        propertiesProperties = KeyIndex(
            type="long"
        )
        propertiesProperties1 = KeyIndex(
            is_chinese_exist=True,
            type="text"
        )
        listPropertiesMapping = {
            "key3": propertiesProperties1,
            "key4": propertiesProperties
        }
        mappingMapping = KeyIndex(
            properties=listPropertiesMapping
        )
        mappingMapping1 = KeyIndex(
            type="keyword"
        )
        listMappingbody = {
            "key1": mappingMapping1,
            "key2": mappingMapping
        }
        request.body = UpdateIndexRequestBody(
            timestamp_field="timestamp",
            status="closed",
            pipe_id="b22106ba-bede-453c-8488-b60c70bd6aed",
            mapping=listMappingbody
        )
        response = client.update_pipe_index(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := secmaster.NewSecMasterClient(
        secmaster.SecMasterClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdatePipeIndexRequest{}
	request.WorkspaceId = "{workspace_id}"
	request.PipeId = "{pipe_id}"
	typeProperties:= model.GetKeyIndexTypeEnum().LONG
	propertiesProperties := model.KeyIndex{
		Type: &typeProperties,
	}
	isChineseExistProperties:= true
	typeProperties1:= model.GetKeyIndexTypeEnum().TEXT
	propertiesProperties1 := model.KeyIndex{
		IsChineseExist: &isChineseExistProperties,
		Type: &typeProperties1,
	}
	var listPropertiesMapping = map[string](model.KeyIndex){
        "key3": propertiesProperties1,
        "key4": propertiesProperties,
    }
	mappingMapping := model.KeyIndex{
		Properties: listPropertiesMapping,
	}
	typeMapping:= model.GetKeyIndexTypeEnum().KEYWORD
	mappingMapping1 := model.KeyIndex{
		Type: &typeMapping,
	}
	var listMappingbody = map[string](model.KeyIndex){
        "key1": mappingMapping1,
        "key2": mappingMapping,
    }
	request.Body = &model.UpdateIndexRequestBody{
		TimestampField: "timestamp",
		Status: model.GetUpdateIndexRequestBodyStatusEnum().CLOSED,
		PipeId: "b22106ba-bede-453c-8488-b60c70bd6aed",
		Mapping: listMappingbody,
	}
	response, err := client.UpdatePipeIndex(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Successful.

400

Error response.

Error Codes

See Error Codes.