Help Center/ Data Security Center/ API Reference/ API Description/ Static Data Masking/ Start/Stop an Elasticsearch Data Masking Task
Updated on 2026-01-13 GMT+08:00

Start/Stop an Elasticsearch Data Masking Task

Function

This API is used to start or stop a specified Elasticsearch data masking task.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/sdg/server/mask/bigdata/templates/{template_id}/operation

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique project ID.

template_id

Yes

String

Masking template/task ID. When you start a task, this field indicates the masking template ID. When you stop a task, this field indicates the masking task ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

status

Yes

Integer

Status of the masking function. The value 0 indicates that the function is disabled, while 1 indicates that the function is enabled.

type

Yes

String

Data type, which can be OBS, DB, BIGDATA, MRS_HIVE, DWS, ES, Hive, Hbase, or DLI.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

msg

String

Returned message content, which is used to describe the operation result.

status

String

Returned status code. For example, 200 indicates success, and 400 indicates an error.

Status code: 201

Resource creation.

Example Requests

POST /v1/{project_id}/sdg/server/mask/bigdata/templates/{template_id}/operation

{
  "status" : 0,
  "type" : "BIGDATA"
}

Example Responses

None

Status Codes

Status Code

Description

200

Operation succeeded.

201

Resource creation.

401

Unauthorized.

403

Access denied.

404

Resource not found.

Error Codes

See Error Codes.