Help Center> VAS> API Reference> Video Content Recognition APIs> Video OCR> Querying the Job List
View PDF

Querying the Job List

Function

Query and display the video OCR job list.

URI

  • URI format: 
    GET /v2/{project_id}/services/video-ocr/tasks
  • Parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

  • Example request 
    GET /v2/6204a5bd270343b5885144cf9c8c158d/services/video-ocr/tasks
  • For details about the request parameters, see queryOption.

Response Parameters

  • Example response 
    {
   "count": 1,
   "tasks": [   
     {   
         "id": "f18320e61e4c4dc685aa2dfc22a28dc5",   
         "name": "ocr-task",   
         "description": "sss",   
         "input": {   
            "type": "obs",   
            "data": [   
                   {   
                    "bucket": "obs-iva",   
                    "path": "input/demo.mp4"   
                   }   
              ]   
        },   
        "output": {
           "obs": {
                  "bucket": "obs-iva",
                  "path": "output/"
           }
        },
         "service_config": {   
              "common": {   
                 "area": "0,0,0.5,0.5;"
                 "threshold": 0.5
              }   
        },   
         "service_version":"1.0",   
         "state": "RUNNING",   
         "created_at": "2018-06-12T13:00:01Z",   
         "updated_at": "2018-06-13T13:00:01Z"   
     }   
  ]
}
  • Response parameters

    Parameter

    Type

    Description

    tasks

    Array of taskDetail

    Job details. For details, see task.detail.

    count

    Integer

    Total number of records that meet the search criteria

Status Codes

  • Normal

    200

  • Abnormal

    Status Code

    Description

    400 Bad Request

    Request error. For details about the returned error code, see Error Codes.

    401 Unauthorized

    Authentication failed.

    403 Forbidden

    No operation permission.

    404 Not Found

    The requested resource was not found.

    500 Internal Server Error

    Internal service error.

    503 Service Unavailable

    Service unavailable.
Parent topic: Video OCR