GetDigitalWatermarkExtractResult - ApsaraVideo VOD

Queries the results of a digital watermark extraction job. You can call this operation to obtain information such as the job status and the content of the copyright or user-tracing watermark.

Operation description

This operation is supported only in the China (Shanghai) and China (Beijing) regions.
You can call this operation to query the watermark content after you call the SubmitDigitalWatermarkExtractJob operation to extract the copyright or user-tracing watermark in a video.
You can query watermark content extracted only from watermark extraction jobs that are submitted in the last 2 years.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
MediaId	string	Yes	The ID of the video from which you want to query the watermark content. You can specify only one ID. You can use one of the following methods to obtain the ID: Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Media Files > Audio/Video to view the video ID. Obtain the VideoId from the response to the SearchMedia operation.	93ab850b4f6f54b6e91d24d81d4****
ExtractType	string	Yes	The type of the watermark. Valid values: TraceMark: user-tracing watermark CopyrightMark: copyright watermark	TraceMark
JobId	string	No	The ID of the watermark extraction job. You can obtain the ID from the response to the SubmitDigitalWatermarkExtractJob operation. If you specify this parameter, the result of the specified watermark extraction job is returned. If you leave this parameter empty, the results of all watermark extraction jobs submitted for the video are returned.	2bf4390af9e5491c09cc720ad****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	42E0554B-80F4-4921-****-ACFB22CAAAD0
AiExtractResultList	array<object>	The details of the watermark extraction job.
	object
JobId	string	The ID of the watermark extraction job.	3af004763bcf459698860f4ede20****
CreateTime	string	The time when the watermark extraction job was created.	2023-09-16T02:49:04Z
ModifyTime	string	The time when the watermark extraction job was last updated.	2023-09-17T06:20:45Z
Status	string	The status of the watermark extraction job. Valid values: Success Failed Processing	Success
ErrorMessage	string	The error message.	successful
WaterMarkText	string	The extracted watermark content.	test mark

Examples

Sample success responses

JSONformat

{
  "RequestId": "42E0554B-80F4-4921-****-ACFB22CAAAD0",
  "AiExtractResultList": [
    {
      "JobId": "3af004763bcf459698860f4ede20****",
      "CreateTime": "2023-09-16T02:49:04Z",
      "ModifyTime": "2023-09-17T06:20:45Z",
      "Status": "Success",
      "ErrorMessage": "successful",
      "WaterMarkText": "test mark"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history