Help Center> Video On Demand> API Reference> OBS hosting management> Queries a hosting task
Updated on 2022-10-24 GMT+08:00
View PDF

Queries a hosting task

Function

Queries OBS inventory hosting tasks

URI

GET /v1.0/{project_id}/asset/obs/host/stock/task

Table 1 Path 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.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

status

No

String

Task status

task_id

No

String

Task ID

page

No

Integer

Page number. The default value is 0.

size

No

Integer

Number of records on each page

The value defaults to 10 and ranges from 1 to 100. This parameter is invalid when task_id is specified.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

tasks

Array of TakeOverTask objects

Hosting task information

total

Integer

Number of tasks
Table 5 TakeOverTask

Parameter

Type

Description

bucket

String

Bucket name

object

String

Directory or file name

host_type

Integer

Hosting type

Possible values are:

  • 0: Files are stored in a VOD bucket.

  • 1: Files are stored in a tenant bucket.

  • 2: Files are stored in a tenant bucket and the storage path is the same as that of the source file.

output_bucket

String

Output bucket

output_path

String

Output path

task_id

String

Task ID

suffix

Array of strings

Hosted file type

template_group_name

String

Transcoding template group

create_time

String

Creation time

end_time

String

End time

status

String

Task status

exec_desc

String

Execution description of media asset tasks

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

GET https://{endpoint}/v1.0/{project_id}/asset/obs/host/stock/task

Example Responses

Status code: 200

The information is returned when the request succeeds.

{
  "tasks" : [ {
    "bucket" : "obs-test",
    "object" : "play_violin.mp4",
    "host_type" : 0,
    "output_bucket" : "",
    "output_path" : null,
    "task_id" : "973",
    "suffix" : [ ],
    "template_group_name" : null,
    "create_time" : "20210629074248",
    "end_time" : "20210629074250",
    "status" : "SUCCEED",
    "exec_desc" : null
  } ],
  "total" : 1
}

Status code: 403

The information is returned when the request fails.

{
  "error_code" : "VOD.10053",
  "error_msg" : "The request parameter is illegal, illegal field: {xx}."
}

Status Codes

Status Code

Description

200

The information is returned when the request succeeds.

403

The information is returned when the request fails.

Error Codes

See Error Codes.

Parent topic: OBS hosting management