Obtaining Job Details

Updated on 2025-02-28 GMT+08:00

View PDF

Function

This API is used to obtain job details.

URI

GET /v1/{project_id}/infer/tasks/{task_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
task_id	Yes	String	Job ID

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It is a response to the API used to obtain a user token. This API is the only one that does not require authentication.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	String	Job ID
name	String	Job name
creator	String	Username of the job creator
project_id	String	Project ID of the job creator
description	String	Job description Minimum: 0 Maximum: 500
release_id	String	ID of the service corresponding to a job
created_at	String	Job creation time
updated_at	String	Time when the latest job status was updated
state	String	Status of a job. Options: PENDING: The job is awaiting. RECOVERING: The job is being recovered. STARTING: The job is starting. UPGRADING: The job is being upgraded. CREATE_FAILED: Creating the job failed. START_FAILED: Starting the job failed. RUNNING: The job is running. STOPPING: The job is being stopped. STOPPED: The job has been stopped. ABNORMAL: The job is abnormal. SUCCEEDED: The job has been executed. FAILED: The job failed to be run. DELETING: The job is being deleted. FREEZING: The job is being frozen. FROZEN: The job has been frozen.
status	String	Details about a job status (for some statuses only) Minimum: 0 Maximum: 4096
error	error object	Error information
schedule_status	String	Status of a scheduled job. Options: ACTIVATED: The job is activated. INACTIVATED: The job is not activated.
schedule	TaskSchedule object	Configuration of a scheduled job. Scheduled jobs do not support OBS input. URL input supports only RTMP and RTSP.
input	TaskInput object	Input configuration of a job
output	TaskOutputForDisplay object	Output configuration of a job
config	TaskServiceConfig object	Job runtime parameters customized by the service publisher
video_source_name	String	Video source name
title	String	Algorithm name
group_name	String	Group name. Multiple values are separated by commas (,).
company	String	Vendor name
task_config	String	Job algorithm configuration
type	String	Service type. Options: cloud and edge
resource_order_id	String	Order ID
package_id	String	Algorithm package ID

**Table 4** error
Parameter	Type	Description
code	String	Error code Minimum: 8 Maximum: 36
message	String	Error description Minimum: 2 Maximum: 512

**Table 5** TaskSchedule
Parameter	Type	Description
type	String	Type of a scheduled job. This parameter is mandatory for scheduled jobs. Options: weekly and monthly
timezone	String	Time zone where a user is located. This parameter is mandatory for scheduled jobs. The value is accurate to the minute.
days_of_week	Array of integers	Days in a week when a job is executed. This parameter is mandatory only for weekly jobs. The values 1 to 7 indicate Monday to Sunday respectively. Minimum: 1 Maximum: 7
days_of_month	Array of integers	Days in a month when a job is executed. This parameter is mandatory only for monthly jobs. The values 1 to 31 indicate the first day to the 31st day of a month. Minimum: 1 Maximum: 31
periods	Array<Array<PeriodsData>>	Time segment configuration. Select at least one time segment for executing a weekly or monthly job.

**Table 6** PeriodsData
Parameter	Type	Description
begin_at	String	Start time of a time segment, which is mandatory. The format is hh:mm:ss.
end_at	String	End time of a time segment, which is mandatory. The format is hh:mm:ss.

**Table 7** TaskInput
Parameter	Type	Description
type	String	Input type of a job. This parameter is mandatory. Options: obs (files stored in OBS, supported only by cloud jobs) vis (video streams from Video Ingestion Service, supported only by cloud jobs) url (specified file URL or stream request URL, supported only by cloud jobs) edgecamera (edge camera bound to IEF, supported only by edge jobs) restful (stream request URL obtained from a user-specified streaming server through a RESTful API, supported by both cloud and edge jobs) vcn (VCN device, supported only by edge jobs)
data	Array of TaskInputData objects	Input details of a job. The configuration varies according to the input type. Multiple inputs are allowed during creation, but only one input is allowed for update.
vcn	TaskInputVcn object	VCN server information. This parameter is mandatory only when the input type is vcn.

**Table 8** TaskInputData
Parameter	Type	Description
video_source_id	String	Video source ID
stream_name	String	Name of a VIS video stream. This parameter is mandatory when the input type is vis.
bucket	String	OBS bucket name. This parameter is mandatory when the input type is obs. Maximum: 63
path	String	OBS path. This parameter is mandatory when the input type is obs. Maximum: 1023
url	String	File URL or RESTful request URL for obtaining a video stream. This parameter is mandatory when the input type is url or edgerestful. The value contains a maximum of 1000 characters. Maximum: 1000
headers	Object	Headers carried in the RESTful request for obtaining a video stream. This parameter is optional when the input type is edgerestful. The value is key-value pairs in JSON format. A maximum of 10 key-value pairs are allowed.
certificate_check	Boolean	Whether to verify the certificate of the HTTPS request. This parameter is mandatory when the input type is edgerestful. The value can be true or false.
rtsp_path_in_response	String	Video stream address in the response body for the RESTful request. This parameter is mandatory when the input type is edgerestful. The value contains a maximum of 1024 characters. Maximum: 1024
node_id	String	ID of an IEF node. This parameter is mandatory only for some services when the input type is edgerestful or vcn.
device_id	String	VCN ID. This parameter is mandatory when the input type is vcn.
stream_type	Integer	Stream type used for analysis. This parameter is optional when the input type is vcn. The value ranges from 1 to 3. The value 1 indicates primary stream, the value 2 indicates secondary stream 1, and the value 3 indicates secondary stream 2. Minimum: 1 Maximum: 3
id	String	ID of the edge device mounted to IEF. This parameter is mandatory when the input type is edgecamera. Maximum: 63

**Table 9** TaskInputVcn
Parameter	Type	Description
ip	String	IP address of the VCN server. This parameter is mandatory only when the input type is vcn.
port	Integer	Port number of the VCN server. This parameter is mandatory only when the input type is vcn. Minimum: 0 Maximum: 65535
username	String	Account name of the VCN server. This parameter is mandatory only when the input type is vcn.
password	String	Password of the VCN server account. This parameter is mandatory only when the input type is vcn.

**Table 10** TaskOutputForDisplay
Parameter	Type	Description
dis	TaskOutputDis object	Configuration information when the output type is dis.
webhook	TaskOutputWebhook object	Configuration information when the output type is webhook.
event_center	Boolean	Default: false

**Table 11** TaskOutputDis
Parameter	Type	Description
stream_name	String	DIS stream name. This parameter is mandatory when the dis type is used. Maximum: 64
data_category	Array of strings	List of job output types. This parameter is optional and is required only for some services. The output contains data in the dataCategory list.

**Table 12** TaskOutputWebhook
Parameter	Type	Description
url	String	Result callback address. This parameter is mandatory when the output type is webhook. Maximum: 1000
headers	Object	Headers carried in result callback. This parameter is mandatory when the output type is webhook. The value is key-value pairs in JSON format. A maximum of 10 key-value pairs are allowed, and a minimum of 1 key-value pair is allowed.
data_category	Array of strings	List of job output types. This parameter is optional and is required only for some services. The output contains data in the dataCategory list.

**Table 13** TaskServiceConfig
Parameter	Type	Description
common	Object	Job runtime configuration items customized by the service publisher. The value must be in JSON format. For details about the configuration items, see the description of the corresponding algorithm service.