Help Center/ Data Security Center/ API Reference/ API Description/ Document Watermarking/ Obtaining Log Details of a Specified Watermark Extraction Task
Updated on 2026-01-13 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining Log Details of a Specified Watermark Extraction Task

Function

This API is used to obtain the log details of a specified watermark extraction task.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/sdg/watermark/extract-log-info

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Number of records displayed on each page.

offset

No

Integer

Pagination offset.

task_id

Yes

String

Task ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Long

Total number of logs.

water_mark_log_info

Array of WatermarkLogResponse objects

Watermark log details list.
Table 4 WatermarkLogResponse

Parameter

Type

Description

blind_watermark

String

Invisible watermark content.

dest_url

String

Target URL.

doc_path

String

Document path.

download_url

String

Download URL.

file_exist

Boolean

Whether the file exists.

file_url

String

File URL.

finish_num

Integer

Completed quantity.

project_id

String

Project ID.

remark

String

Remarks.

state

Integer

Task status.

task_id

String

Task ID.

task_name

String

Task name.

total_file_num

Integer

Total number of files.

visible_watermark

String

Visible watermark.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Obtained.

401

Unauthorized.

403

Access denied.

404

Task not found.

Error Codes

See Error Codes.

Parent topic: Document Watermarking