Obtaining the List of Database Watermark Extraction Tasks
Function
This API is used to obtain the database watermark extraction tasks of a specified project.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/data-watermark-extract-tasks
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
end |
No |
Long |
End time (filtering condition). |
|
id |
No |
Long |
Task ID (filtering condition). |
|
limit |
No |
Integer |
Number of records displayed on each page. |
|
name |
No |
String |
Task name (filtering condition). |
|
offset |
No |
Integer |
Pagination offset. |
|
start |
No |
Long |
Start time (filtering condition). |
|
status |
No |
String |
Task status (filtering condition). |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
result |
Array of TaskDetail objects |
Task details list. |
|
total_num |
Long |
Total tasks. |
|
Parameter |
Type |
Description |
|---|---|---|
|
db_water_param |
DbWatermarkParam object |
Database watermarking parameters. |
|
extract_running_flag |
String |
Extract the runtime status. |
|
file_name |
String |
File name. |
|
id |
Long |
Task ID. |
|
schedule_switch |
Boolean |
Scheduling switch. |
|
schedule_type |
String |
Scheduling type. |
|
selected_fields |
Array of ColumnInfo objects |
List of selected fields. |
|
source_db_info |
DbInfo object |
Source database information. |
|
start_now |
Boolean |
Whether to start immediately. |
|
start_time |
Long |
Start time. |
|
target_db_info |
DbInfo object |
Target database information. |
|
task_create_time |
Long |
Task creation time. |
|
task_end_time |
Long |
Task end time. |
|
task_name |
String |
Task name. |
|
task_state |
String |
Task status. |
|
water_describe |
String |
Watermark description. |
|
water_extract_result |
String |
Watermark extraction result. |
|
water_mark |
String |
Watermark content. |
|
watermark_describe |
String |
Watermark description. |
|
watermark_version |
String |
Watermark version. |
|
Parameter |
Type |
Description |
|---|---|---|
|
embed_mode |
String |
Embedding mode. |
|
params |
Array of EmbedParam objects |
Embedding parameter list. |
|
row_spacing |
String |
Line spacing. |
|
watermark_key |
String |
Watermark key. |
|
Parameter |
Type |
Description |
|---|---|---|
|
fake_param |
FakeParam object |
Simulation parameter configuration. |
|
fake_strategy |
String |
Simulation data generation policy. |
|
new_column_name |
String |
New field name. |
|
new_column_type |
String |
New field type. |
|
Parameter |
Type |
Description |
|---|---|---|
|
address_accuracy |
String |
Address precision. |
|
date_begin |
String |
Start date range. |
|
date_end |
String |
End date range. |
|
random_accuracy |
Integer |
Random precision. |
|
random_begin |
String |
Start of the random range. |
|
random_distribute |
String |
Random distribution mode. |
|
random_end |
String |
End of the random range. |
|
string_distribute |
String |
String distribution mode. |
Example Requests
None
Example Responses
None
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Obtained. |
|
401 |
Unauthorized. |
|
403 |
Access denied. |
|
404 |
Project 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