修改批量配置任务
功能介绍
修改批量配置任务
调用方法
请参见如何调用API。
URI
PUT /v2/{project_id}/batch-tasks/{id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
用户项目ID，获取方法参见获取项目ID和名称 |
|
id |
是 |
String |
批量配置ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token，获取方法参见认证鉴权 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
否 |
String |
任务的名称，必填。仅能包含汉字、字母、数字、中划线和下划线，长度介于1~100之间 |
|
description |
否 |
String |
任务的描述，选填。长度不超过500 |
|
schedule |
否 |
TaskSchedule object |
定时任务参数 |
|
batch_input |
否 |
BatchTaskInputDto object |
任务的输入配置 |
|
output |
否 |
TaskOutput object |
任务的输出配置 |
|
config |
否 |
TaskServiceConfig object |
任务配置参数 |
|
is_saved_as_template |
否 |
Boolean |
是否保存为模板 |
|
resource_order_id |
否 |
String |
资源订单id，与关联算法挂钩。非商用白名单的算法 就不用填，商用算法就为必填项，需要满足正则表达式^[a-z0-9-_]{4,36}$。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
type |
是 |
String |
计划任务的类型，使用计划任务时必填。可选类型weekly（每周执行）。 |
|
timezone |
是 |
String |
用户所处的时区，使用计划任务时必填。精确到分钟 |
|
days_of_week |
否 |
Array of integers |
任务会在一周的哪几天执行，当且仅当计划任务类型为weekly时，该字段需填且必填。1~7分别指代星期一至星期日 |
|
days_of_month |
否 |
Array of integers |
任务会在一个月的哪几天执行，当且仅当计划任务类型为monthly时，该字段需填且必填。1~31分别指代一个月中的1日至31日，当前系统不支持该参数。 |
|
periods |
否 |
Array<Array<TimeWindow>> |
时间段模式配置，指定周计划或者月计划中具体每天任务的执行时间段，至少需指定一个时间段 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
begin_at |
是 |
String |
单个时间段执行的起始时间，必填。其余计划任务类型时，格式为hh:mm:ss。 |
|
end_at |
是 |
String |
单个时间段执行的结束时间，必填，其余计划任务类型时，格式为hh:mm:ss。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
video_source_group |
否 |
Array of BatchTaskVideoSourceGroupDto objects |
视频源分组信息 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
video_source_group_id |
是 |
String |
视频源分组id |
|
video_source_list |
是 |
Array of BatchTaskInputVideoSourceDto objects |
视频源列表 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
video_source_id |
是 |
String |
视频源id |
|
target_roi |
否 |
String |
roi区域 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
obs |
否 |
TaskOutputObs object |
输出为obs类型时的配置信息 |
|
dis |
否 |
TaskOutputDis object |
输出为dis类型时的配置信息 |
|
webhook |
否 |
TaskOutputWebhook object |
输出为webhook类型时的配置信息 |
|
event_center |
否 |
Boolean |
输出方式是否选择为事件中心,选择 true或者1表示是,默认为false |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
bucket |
是 |
String |
OBS桶名，选用obs类型输出时必填，校验规则：(pattern:“^[a-z0-9](?!.[-.][-.].)([a-z0-9-.]{1,61})[a-z0-9]$”) |
|
path |
是 |
String |
OBS的路径，选用obs类型输出时必填，校验规则：^(?![/.\s])(?!.//.)([^:*?"<>|\]{0,1023})(?<![.\s])$ |
|
data_category |
否 |
Array of strings |
作业输出数据类别的列表，选填，仅部分服务需要。当输出类型下有这个列表时，表示希望这个输出类型下存放dataCategory列表内的数据 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
stream_name |
是 |
String |
DIS流名称，选用dis类型输出时必填，校验规则：^[-A-Za-z0-9_]{1,64}$。 |
|
data_category |
否 |
Array of strings |
任务输出数据类别的列表，选填，仅部分服务需要。当输出类型下有这个列表时，表示希望这个输出类型下存放dataCategory列表内的数据。 【例如创建边缘人脸任务API中，输出结果支持data_category参数，取值范围为[FacaImage,OriginImage],分别表示是否发送人脸图和原始图】 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_count |
Integer |
作业总数 |
|
failed_count |
Integer |
失败作业数量 |
|
succeed_count |
Integer |
成功作业数量 |
|
id |
String |
批量作业id |
|
error_list |
Array of strings |
错误信息列表 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息描述 |
|
detail |
String |
错误详情 |
|
params |
Array of strings |
错误参数列举 |
|
reason |
String |
错误原因 |
|
advice |
String |
建议 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息描述 |
|
detail |
String |
错误详情 |
|
params |
Array of strings |
错误参数列举 |
|
reason |
String |
错误原因 |
|
advice |
String |
建议 |
请求示例
修改配置名称为“wdwd”使用算法名为“烟火演示算法”版本为“1.0”厂商为“VIAS”不保存模板输入方式为“video_source”输出方式为“webhook”有相关算法配置的批量配置
/v2/{project_id}/batch-tasks/{id}
{
"name" : "wdwdxx",
"service_name" : "烟火演示算法",
"service_version" : "1.0",
"manufacturer" : "VIAS",
"priority" : "low",
"is_saved_as_template" : false,
"description" : "",
"batch_input" : {
"video_source_group" : [ {
"video_source_group_id" : "xxxxxxx-xxxxxxx-xxxxxxx-xxxxx-xxxxxx",
"video_source_list" : [ {
"video_source_id" : "xxxxxxx-xxxxxxx-xxxxxxx-xxxxx-xxxxxx"
} ]
} ]
},
"output" : {
"webhook" : {
"url" : "http://test",
"headers" : {
"a" : "a"
}
}
},
"config" : {
"common" : {
"render_result_sw" : 1,
"fire_detection_sw" : 1,
"smoke_detection_sw" : 1
}
}
}响应示例
状态码： 200
批量操作响应体
{
"total_count" : 1,
"failed_count" : 0,
"succeed_count" : 1,
"id" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"error_list" : [ ]
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
批量操作响应体 |
|
400 |
请求错误 |
|
500 |
内部错误 |
