Obtaining Details of a Specified Elasticsearch Data Masking Task
Function
This API is used to obtain details of a specified Elasticsearch data masking task.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/sdg/server/mask/bigdata/templates/{template_id}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Unique project ID. |
|
template_id |
Yes |
String |
Masking task ID. |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
data_dest |
Array of DataDest objects |
Target data configuration list of the Elasticsearch data masking task. |
|
data_source |
Array of DataSource objects |
Source data configuration list of the Elasticsearch data masking task. |
|
db_type |
String |
Database type, which can be OBS, DB, BIGDATA, MRS_HIVE, DWS, ES, Hive, Hbase, or DLI. |
|
status |
Integer |
Status of the Elasticsearch data masking task. |
|
strategy |
Array of Strategy objects |
List of masking policies of the Elasticsearch data masking task. |
|
template_id |
String |
Unique ID of the Elasticsearch data masking task. |
|
template_name |
String |
Name of an Elasticsearch data masking task |
|
trigger_time |
String |
Time when the Elasticsearch data masking task is triggered. |
|
type |
String |
Running type. The value can be AUTO or MANUAL. |
|
Parameter |
Type |
Description |
|---|---|---|
|
data_dest_id |
String |
Unique ID of the data target. |
|
db_name |
String |
Database name |
|
dest_ins_id |
String |
Unique ID of the target instance. |
|
dst_asset_id |
String |
Unique ID of the target instance. |
|
dst_obs_bucket_name |
String |
Name of the target OBS bucket. |
|
dst_obs_path |
String |
Target OBS path |
|
index_name |
String |
Index name |
|
schema |
String |
Database mode |
|
table_name |
String |
Database table name. |
|
type_name |
String |
Type of a data target. |
|
Parameter |
Type |
Description |
|---|---|---|
|
db_type |
String |
Database type of the data source, including OBS, DB, BIGDATA, MRS_HIVE, DWS, ES, Hive, Hbase, and DLI. |
|
ins_id |
String |
Unique ID of the data source instance. |
|
Parameter |
Type |
Description |
|---|---|---|
|
algorithm |
String |
Encryption and masking algorithm type. The value can be SHA256, SHA512, PRESNM, MASKNM, PRESXY, MASKXY, SYMBOL, KEYWORD, NULL, EMPTY, DATE, NUMERIC, AES, EMBED, SM4, or DECRYPT. |
|
algorithm_id |
String |
Unique ID of the masking algorithm used by the masking policy. |
|
algorithm_type |
String |
Type of the masking algorithm, such as hash masking and encryption masking. The value can be MASK_BY_HASH, MASK_BY_ENCRYPT, MASK_BY_OVERWRITE, MASK_BY_KEYWO RDS _EXCHANGE, MASK_BY_NULL, or MASK_BY. |
|
dest_column_name |
String |
Name of the target column. |
|
dest_field_name |
String |
Name of the target field. |
|
enable |
Boolean |
Whether the masking policy is enabled. |
|
parameter |
Object |
Configuration parameters of the masking policy |
|
rule_name |
String |
Name of the masking rule. |
|
src_column_name |
String |
Name of the source column. |
|
src_field_name |
String |
Name of the source field. |
Example Requests
None
Example Responses
None
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Query result. |
|
401 |
Unauthorized. |
|
403 |
Access denied. |
|
404 |
Resource not found. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot