文档首页/ 视频智能分析服务 VIAS/ API参考/ 平台API/ 任务中心/ 修改批量配置任务

更新时间：2024-04-22 GMT+08:00

修改批量配置任务

功能介绍

修改批量配置任务

URI

PUT /v2/{project_id}/batch-tasks/{id}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	用户项目ID，获取方法参见获取项目ID和名称
id	是	String	批量配置ID

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token，获取方法参见认证鉴权

表3 请求Body参数
参数	是否必选	参数类型	描述
name	否	String	任务的名称，必填。仅能包含汉字、字母、数字、中划线和下划线，长度介于1~100之间
description	否	String	任务的描述，选填。长度不超过500 最小长度：0 最大长度：500
schedule	否	TaskSchedule object	定时任务参数
batch_input	否	BatchTaskInputDto object	任务的输入配置
output	否	TaskOutput object	任务的输出配置
config	否	TaskServiceConfig object	任务配置参数
is_saved_as_template	否	Boolean	是否保存为模板缺省值：false
resource_order_id	否	String	资源订单id，与关联算法挂钩。非商用白名单的算法就不用填，商用算法就为必填项，需要满足正则表达式^[a-z0-9-_]{4,36}$。

表4 TaskSchedule
参数	是否必选	参数类型	描述
type	是	String	计划任务的类型，使用计划任务时必填。可选类型weekly（每周执行）。
timezone	是	String	用户所处的时区，使用计划任务时必填。精确到分钟
days_of_week	否	Array of integers	任务会在一周的哪几天执行，当且仅当计划任务类型为weekly时，该字段需填且必填。1~7分别指代星期一至星期日最小值：1 最大值：7 数组长度：1 - 7
days_of_month	否	Array of integers	任务会在一个月的哪几天执行，当且仅当计划任务类型为monthly时，该字段需填且必填。1~31分别指代一个月中的1日至31日，当前系统不支持该参数。最小值：1 最大值：31
periods	否	Array<Array<>>	时间段模式配置，指定周计划或者月计划中具体每天任务的执行时间段，至少需指定一个时间段

表5 BatchTaskInputDto
参数	是否必选	参数类型	描述
video_source_group	否	Array of BatchTaskVideoSourceGroupDto objects	视频源分组信息数组长度：1 - 100

表6 BatchTaskVideoSourceGroupDto
参数	是否必选	参数类型	描述
video_source_group_id	是	String	视频源分组id
video_source_list	是	Array of BatchTaskInputVideoSourceDto objects	视频源列表数组长度：0 - 100

表7 BatchTaskInputVideoSourceDto
参数	是否必选	参数类型	描述
video_source_id	是	String	视频源id
target_roi	否	String	roi区域最小长度：0 最大长度：2048

表8 TaskOutput
参数	是否必选	参数类型	描述
obs	否	TaskOutputObs object	输出为obs类型时的配置信息
dis	否	TaskOutputDis object	输出为dis类型时的配置信息
webhook	否	TaskOutputWebhook object	输出为webhook类型时的配置信息
event_center	否	Boolean	输出方式是否选择为事件中心,选择 true或者1表示是,默认为false 缺省值：false

表9 TaskOutputObs
参数	是否必选	参数类型	描述
bucket	是	String	OBS桶名，选用obs类型输出时必填，校验规则：(pattern:“^[a-z0-9](?!.[-.][-.].)([a-z0-9-.]{1,61})[a-z0-9]$”) 最大长度：63
path	是	String	OBS的路径，选用obs类型输出时必填，校验规则：^(?![/.\s])(?!.//.)([^:?"<>\|\]{0,1023})(?<![.\s])$ 最大长度：1023*
data_category	否	Array of strings	作业输出数据类别的列表，选填，仅部分服务需要。当输出类型下有这个列表时，表示希望这个输出类型下存放dataCategory列表内的数据数组长度：0 - 10

**表10** TaskOutputDis
参数	是否必选	参数类型	描述
stream_name	是	String	DIS流名称，选用dis类型输出时必填，校验规则：^[-A-Za-z0-9_]{1,64}$。最大长度：64
data_category	否	Array of strings	任务输出数据类别的列表，选填，仅部分服务需要。当输出类型下有这个列表时，表示希望这个输出类型下存放dataCategory列表内的数据。【例如创建边缘人脸任务API中，输出结果支持data_category参数，取值范围为[FacaImage,OriginImage],分别表示是否发送人脸图和原始图】数组长度：0 - 10

**表11** TaskOutputWebhook
参数	是否必选	参数类型	描述
url	是	String	结果回调地址，选用webhook类型输出时必填最大长度：1000
headers	是	Object	结果回调时需要携带的请求头，选用webhook类型输出时必填。整体呈json格式，以键值对的形式表示请求头和取值，至少1组，至多10组
data_category	否	Array of strings	任务输出数据类别的列表，选填，仅部分服务需要。当输出类型下有这个列表时，表示希望这个输出类型下存放dataCategory列表内的数据数组长度：0 - 10

**表12** TaskServiceConfig
参数	是否必选	参数类型	描述
common	否	Object	任务运行时指定的具体的自定义配置项，由服务发布者定义。整体呈json格式，具体配置项参见相应算法服务的说明

响应参数

状态码： 200

**表13** 响应Body参数
参数	参数类型	描述
total_count	Integer	作业总数
failed_count	Integer	失败作业数量
succeed_count	Integer	成功作业数量
id	String	批量作业id
error_list	Array of strings	错误信息列表

状态码： 400

**表14** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误信息描述
detail	String	错误详情
params	Array of strings	错误参数列举数组长度：0 - 1
reason	String	错误原因
advice	String	建议

状态码： 500

**表15** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误信息描述
detail	String	错误详情
params	Array of strings	错误参数列举数组长度：0 - 1
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	内部错误

错误码

请参见错误码。

父主题： 任务中心

上一篇：启动/停止批量配置任务

下一篇：删除批量配置任务

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消