All Products
Search

This Product

    ApsaraVideo VOD:GetWorkflowTask

    Document Center

    ApsaraVideo VOD:GetWorkflowTask

    Last Updated:Aug 19, 2026

    Queries the execution information of a workflow task.

    Operation description

    • Before you use this operation, make sure that you are familiar with the billing methods and pricing of ApsaraVideo VOD. Using workflows may incur fees for transcoding, encryption, automated review, and other services. For billing details, see Billing overview.

    • You can call this operation to query workflow processing tasks. This operation currently supports only video understanding workflow task queries. Workflow tasks of other versions are not supported.

    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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request syntax

    GET  HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    TaskId

    string

    No

    The task ID used to query the refresh status.

    70422****

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    Id of the request

    63E8B7C7-4812-46*****AD-0FA56029AC86
    WorkflowId

    string

    The workflow ID. You can log on to the ApsaraVideo VOD console and choose Configuration Management > Media Processing > Workflow Management to view the ID.

    613efff3887ec34af685714cc461****
    TaskId

    string

    The task ID used to query the refresh status.

    70422****
    Status

    string

    The result of this review. This indicates the current manual review result. Valid values:

    • running: Running.

    • stopped: Stopped.

    • failed: Failed.

    • partial-succeeded: Partially succeeded.

    • succeeded: Succeeded.

    succeeded
    GmtCreateUtc

    string

    The time when the task was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format.

    2025-07-28T02:17:26Z
    FinishTimeUtc

    string

    The time when the task was completed. The time is in the yyyy-MM-ddTHH:mm:ssZ format.

    2025-08-19T02:28:22Z
    Outputs

    string

    The output information.

    {}
    NodeResults

    string

    The node results of the workflow task. The value is in JSON format and varies based on the workflow configuration.

    {}
    ErrorCode

    string

    The error code returned when transcoding fails.

    200
    ErrorMessage

    string

    The error message returned when transcoding fails.

    ErrorMessage
    UserData

    string

    The custom information.

    {}

    Examples

    Success response

    JSON format

    {
  "RequestId": "63E8B7C7-4812-46*****AD-0FA56029AC86",
  "WorkflowId": "613efff3887ec34af685714cc461****",
  "TaskId": "70422****",
  "Status": "succeeded",
  "GmtCreateUtc": "2025-07-28T02:17:26Z",
  "FinishTimeUtc": "2025-08-19T02:28:22Z",
  "Outputs": "{}",
  "NodeResults": "{}",
  "ErrorCode": "200",
  "ErrorMessage": "ErrorMessage",
  "UserData": "{}"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.