All Products
Search
Document Center

ApsaraVideo VOD:GetDigitalWatermarkExtractResult

Last Updated:Dec 19, 2024

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vod:GetDigitalWatermarkExtractResultget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
MediaIdstringYes

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****
ExtractTypestringYes

The type of the watermark. Valid values:

  • TraceMark: user-tracing watermark
  • CopyrightMark: copyright watermark
TraceMark
JobIdstringNo

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

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

42E0554B-80F4-4921-****-ACFB22CAAAD0
AiExtractResultListarray<object>

The details of the watermark extraction job.

AiExtractResultobject
JobIdstring

The ID of the watermark extraction job.

3af004763bcf459698860f4ede20****
CreateTimestring

The time when the watermark extraction job was created.

2023-09-16T02:49:04Z
ModifyTimestring

The time when the watermark extraction job was last updated.

2023-09-17T06:20:45Z
Statusstring

The status of the watermark extraction job. Valid values:

  • Success
  • Failed
  • Processing
Success
ErrorMessagestring

The error message.

successful
WaterMarkTextstring

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 timeSummary of changesOperation
No change history