All Products
Search

This Product

    ApsaraVideo VOD:GetDigitalWatermarkExtractResult

    Document Center

    ApsaraVideo VOD:GetDigitalWatermarkExtractResult

    Last Updated:Jul 21, 2026

    Queries the results of a digital watermarking (copyright watermark or tracing watermark) extraction job, including the job status and the successfully extracted watermark text.

    Operation description

    • Currently, this operation is available only in the China (Shanghai) and China (Beijing) regions.

    • After you call the SubmitDigitalWatermarkExtractJob operation to extract the copyright watermark or tracing watermark from a video, call this operation to query the extracted watermark text.

    • Only watermark extraction jobs from the last 2 years can be queried.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    vod:GetDigitalWatermarkExtractResult

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    MediaId

    string

    Yes

    The ID of the video to query. Only a single video ID is supported. You can obtain the video ID by using the following methods:

    • Log on to the ApsaraVideo VOD console and choose Media Files > Audio/Video to view the video ID.

    • Call the SearchMedia operation. The video ID (VideoId) is returned in the response.

    93ab850b4f6f54b6e91d24d81d4****
    ExtractType

    string

    Yes

    The type of watermark extraction. Valid values:

    • TraceMark: tracing watermark.

    • CopyrightMark: copyright watermark.

    TraceMark
    JobId

    string

    No

    The ID of the watermark extraction job.

    • The job ID is returned after you call the SubmitDigitalWatermarkExtractJob operation.

    • If you specify this parameter, the result of the specified watermark extraction job is returned. If you do not specify this parameter, the results of all historical watermark extraction jobs for the video are returned.

    2bf4390af9e5491c09cc720ad****

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

    42E0554B-80F4-4921-****-ACFB22CAAAD0
    AiExtractResultList

    array<object>

    The details of the watermark extraction jobs.

    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: The job succeeded.

    • Failed: The job failed.

    • Processing: The job is being processed.

    Failed
    ErrorMessage

    string

    The error message. This parameter is returned only when the watermark extraction job fails (the value of Status is Failed).

    query copyright info err
    WaterMarkText

    string

    The extracted watermark text.

    test mark

    Examples

    Success response

    JSON format

    {
  "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

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.