本文导读

展开导读

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

修改任务

更新时间：2025-02-24 GMT+08:00

在线调试

CLI示例

查看PDF

功能介绍

任务修改接口，用于修改任务配置

调用方法

请参见如何调用API。

URI

PUT /v2/{project_id}/tasks/{task_id}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	用户项目ID，获取方法参见获取项目ID和名称
task_id	是	String	已创建成功任务的id信息

请求参数

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

表3 请求Body参数
参数	是否必选	参数类型	描述
name	是	String	任务名称，只能由中文、字母（a～z A～Z）、数字（0～9）、中划线（-）、下划线（_）组成，长度范围为[1，100]
description	否	String	任务的描述，选填。长度不超过500
schedule	否	TaskSchedule object	定时任务参数，定时周期仅支持周模式
input	是	TaskInput object	任务的输入配置，必填
output	是	TaskOutput object	作业的输出配置，至少需要配置一项输出方式
config	否	TaskServiceConfig object	任务配置参数
is_saved_as_template	否	Boolean	是否保存为模板
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分别指代星期一至星期日
days_of_month	否	Array of integers	任务会在一个月的哪几天执行，当且仅当计划任务类型为monthly时，该字段需填且必填。1~31分别指代一个月中的1日至31日，当前系统不支持该参数。
periods	否	Array<Array<TimeWindow>>	时间段模式配置，指定周计划或者月计划中具体每天任务的执行时间段，至少需指定一个时间段

表5 TimeWindow
参数	是否必选	参数类型	描述
begin_at	是	String	单个时间段执行的起始时间，必填。其余计划任务类型时，格式为hh:mm:ss。
end_at	是	String	单个时间段执行的结束时间，必填，其余计划任务类型时，格式为hh:mm:ss。

表6 TaskInput
参数	是否必选	参数类型	描述
type	是	String	任务的输入类型，创建时必填，视频源类型为video_source 时不支持切换为其他的type。创建时可选类型有 obs（对象存储服务存储的文件仅云上任务支持，支持输出到webhook）， url（指定的文件地址或取流地址仅云上任务支持，支持输出到webhook）， edgecamera（绑定在IEF的边缘摄像头仅边缘任务支持，支持输出到webhook）, restful（从自定义的流媒体服务器通过Restful接口获取取流地址云上和边缘任务均支持，支持输出到webhook）， vcn（VCN设备仅边缘任务支持）, video_source（使用VIAS平台视频中心管理的视频源，云上和边缘任务均支持），建议使用video_source类型，其他类型为了兼容老业务，后续将废弃。枚举值： video_source obs (不建议使用，后续废弃) url (不建议使用，后续废弃) edgecamera (不建议使用，后续废弃) restful (不建议使用，后续废弃) vcn (不建议使用，后续废弃)
data	是	Array of TaskInputData objects	任务的输入详情，必填。针对不同的输入类型有不同的配置。创建时允许填写多路输入，但更新时只允许填写一路输入。当输入类型为：obs，需要配置 bucket，path ， index 。例如： "bucket": "aicam", "path": "3rdpartylicenses.txt", "index": 0 当输入类型为：url，需要配置 url， index 。例如： "url": "https://xxx-xxx.com", "index": 0 当输入类型为：restful，需要配置 certificate_check， rtsp_path_in_response， url， index， headers 。例如："certificate_check": true, "url": "https://hsaij-dasahbi.com", "rtsp_path_in_response": "data/url", "index": 0, "headers": { "AAA": "AAA" } 当输入类型为：vcn，需要配置 device_id， stream_type， index。例如："device_id": "21356478954612546874#gdhjkiushdgdksjhslmhscjsckjhdbnk", "stream_type": 1, "index": 0 当输入类型为：EdgeCamera，需要配置 id， index 例如："id": "007cdafc-6000-47ce-b0e3-870b4a0db65e","index": 0
vcn	否	TaskInputVcn object	VCN服务器信息，仅输入类型为vcn时需填且必填

表7 TaskInputData
参数	是否必选	参数类型	描述
video_source_id	否	String	视频源id,当输入类型为video_source时必填。
stream_name	否	String	视频流名称
bucket	否	String	OBS桶名，当输入为obs类型时必填
path	否	String	OBS的路径，当输入为obs类型时必填
url	否	String	url输入源的地址或者获取视频流地址的restful请求地址，当输入为url类型或者edgerestful类型时必填。长度不超过1000
headers	否	Object	获取视频流地址的restful请求携带的请求头，当输入为edgerestful类型时可选。整体呈json格式，以键值对的形式表示请求头和取值，最多允许10组。
rtsp_path_in_response	否	String	restful请求返回的body中，视频流地址的路径，当输入为edgerestful类型时必填。长度不超过1024。
device_id	否	String	VCN设备ID，当输入为vcn类型时必填
stream_type	否	Integer	准备进行分析的码流，当输入为vcn类型时选填。取值范围为1~3，其中1代表主码流，2代表子码流1,3代表子码流2
id	否	String	IEF挂载的边缘设备的ID，当输入为edgecamera类型时必填
certificate_check	否	Boolean	是否需要对https请求进行证书校验，当输入为edgerestful类型时必填。取值为true或者false。

表8 TaskInputVcn
参数	是否必选	参数类型	描述
ip	是	String	VCN服务器的IP地址，仅输入类型为vcn时需填且必填
port	是	Integer	VCN服务器的端口号，仅输入类型为vcn时需填且必填
username	是	String	VCN服务器的账号名，仅输入类型为vcn时需填且必填,需要满足正则表达式^.{1,100}$。
password	是	String	VCN服务器的与账号对应的密码，仅输入类型为vcn时需填且必填,需要满足正则表达式^.{1,1000}$。

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

**表10** TaskOutputObs
参数	是否必选	参数类型	描述
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列表内的数据

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

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

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

响应参数

状态码： 400

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

状态码： 500

**表15** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误信息描述
detail	String	错误详情
params	Array of strings	错误参数列举
reason	String	错误原因
advice	String	建议

请求示例

任务修改接口，用于修改任务配置(支持修改任务名称，视频源，调度模式，输出配置)

/v2/{project_id}/tasks/{task_id}

{
  "name" : "TestA",
  "input" : {
    "type" : "video_source",
    "data" : [ {
      "video_source_id" : "xxxxxxx-xxxxxxx-xxxxxxx-xxxxx-xxxxxx"
    } ]
  },
  "output" : {
    "webhook" : {
      "url" : "http://test",
      "headers" : {
        "a" : "a"
      }
    }
  },
  "config" : {
    "common" : { }
  },
  "priority" : "low",
  "service_version" : "1.1",
  "manufacturer" : "VIAS",
  "is_saved_as_template" : false
}

响应示例

无

状态码

状态码	描述
200	任务编辑成功
400	请求错误
500	内部错误

父主题： 任务中心

上一篇：任务启停

下一篇：获取任务列表

意见反馈

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

有帮助没帮助

提供反馈

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

系统繁忙，请稍后重试

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

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

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

字符长度不能超过500

直接提交取消