获取作业详情
功能介绍
该接口用于查询所选视频分析服务的指定作业的详情。
URI
GET /v2/{project_id}/services/{service_name}/tasks/{task_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
用户项目ID。获取方法请参见获取项目ID/帐号名/AK/SK。 |
service_name |
是 |
String |
服务名称。 |
task_id |
是 |
String |
指定的服务作业ID。 |
请求参数
无。
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
作业ID。 |
name |
String |
作业的名称。 |
creator |
String |
作业创建者的用户名。 |
project_id |
String |
作业创建者的项目ID。 |
description |
String |
作业的描述。 最小长度:0 最大长度:500 |
service_name |
String |
作业对应服务的名称。 最小长度:2 最大长度:100 |
service_version |
String |
作业对应服务的版本号。 |
service_title |
service_title object |
作业对应服务的标题。 |
edge_pool_id |
String |
作业运行所在的边缘运行池ID,仅边缘作业会出现。 |
resource_order_id |
String |
作业指定的算法能力包包周期订单ID。 |
created_at |
String |
作业创建的时间。 |
updated_at |
String |
作业最近一次状态更新的时间。 |
state |
String |
作业当前的状态,分别为PENDING(等待中),RECOVERING(恢复中),STARTING(启动中),UPGRADING(升级中),CREATE_FAILED(创建失败),START_FAILED(启动失败),RUNNING(运行中),STOPPING(停止中),STOPPED(已停止),ABNORMAL(异常),SUCCEEDED(运行成功),FAILED(运行失败),DELETING(删除中),FREEZING(冻结中),FROZEN(已冻结) 枚举值:
|
status |
String |
作业状态的详情信息,仅部分状态会有详情信息。 最小长度:0 最大长度:4096 |
error |
error object |
作业运行失败时收集到的错误信息。 |
timing_status |
String |
计划任务的状态,分别为ACTIVATED(激活),INACTIVATED(未激活)。 枚举值:
|
timing |
TaskTiming object |
计划任务的配置项,选填。计划任务不支持obs输入,对于url输入则仅支持rtmp和rtsp两种形式。 |
input |
TaskInput object |
作业的输入配置,必填。 |
output |
TaskOutputForDisplay object |
作业的输出配置展示。 |
service_config |
TaskServiceConfig object |
作业运行时指定的算法配置参数,部分服务需填且为必选参数。 |
hosting_result |
hosting_result object |
hosting结果文件的相关信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
overdue_date |
String |
结果文件result.json的过期时间。 |
status |
String |
结果文件result.json的状态。 枚举值:
|
data |
String |
结果文件result.json的具体内容。 |
file_size |
String |
结果文件result.json的大小。 最小长度:0 最大长度:25 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
服务内部错误码。 |
error_msg |
String |
错误信息。 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
服务内部错误码。 |
error_msg |
String |
错误信息。 |
请求示例
获取指定服务下的指定作业
GET /v2/b722xxxxxxxxxxxxxxxxxxxxxxeb4674/services/face-detect/tasks/53e4xxxxxxxxxxxxxxxxxxxxxxb55b3e
响应示例
状态码: 200
获取服务作业信息成功
{
"id" : "53e4xxxxxxxxxxxxxxxxxxxxxxb55b3e",
"name" : "task-test",
"creator" : "user_test",
"project_id" : "b722xxxxxxxxxxxxxxxxxxxxxxeb4674",
"description" : "hello world",
"service_name" : "face-detect",
"service_version" : "1.0",
"service_title" : {
"en" : "Face Detect",
"zh" : "人脸检测"
},
"edge_pool_id" : "549cxxxxxxxxxxxxxxxxxxxxxx77a2a5",
"created_at" : "2021-01-01T00:00:00Z",
"updated_at" : "2021-01-01T00:00:10Z",
"state" : "RUNNING",
"input" : {
"type" : "edgecamera",
"data" : [ {
"id" : "dd8xxxxx-xxxx-xxxx-xxxx-xxxxxx2f5bcb"
} ]
},
"output" : {
"dis" : {
"stream_name" : "dis-test"
}
},
"service_config" : {
"common" : {
"image_compression_ratio" : 90,
"render_result_sw" : 0,
"video_sampling_interval" : 1
}
}
}
状态码: 400
请求不合法
{ "error_code" : "IVA.0004", "error_msg" : "The request param is invalid. parameter [task_id] does not match ^[0-9a-f]{32}|task\\w{8}$." }
状态码: 404
指定的服务不存在
{ "error_code" : "IVA.0005", "error_msg" : "The requested resource is NOT found. Service face-detect not found." }
状态码
状态码 |
描述 |
---|---|
200 |
获取服务作业信息成功。 |
400 |
请求不合法。 |
404 |
指定的服务不存在。 |
错误码
请参见错误码。