新增取回任务

最近更新时间:2023-04-26 17:37:06

我的收藏

功能描述

用于新建取回任务。

请求

请求url

POST /ivc/record/retrievetask/add

请求参数

此接口无请求参数。

请求头

此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。

请求体

该请求操作的实现需要有如下请求体。
{
"TaskName": "name",
"StartTime": 1658973728,
"EndTime": 1658973828,
"Mode": 1,
"Expiration": 10,
"Channels": [
{
"DeviceId": "",
"ChannelId": ""
},
{
"DeviceId": "",
"ChannelId": ""
}
]
}
字段名
类型
描述
必须
备注
TaskName
string
任务名称
仅支持中文、英文、数字、_、-,长度不超过32个字符,模板名称全局唯一,不能为空,不能重复
StartTime
timestamp
取回录像的开始时间
UTC 秒数,例如:1662114146,开始和结束时间段最长为一天,且不能跨天
EndTime
timestamp
取回录像的结束时间
UTC 秒数,例如:1662114146,开始和结束时间段最长为一天,且不能跨天
Mode
int
取回模式
1:极速模式,其他暂不支持
Expiration
int
取回录像副本有效期
最小为1天,最大为365天
Channels
object
设备通道
一个任务最多32个设备通道
Channels
字段名
类型
描述
必须
备注
DeviceId
string
设备 ID
-
ChannelId
string
通道 ID
-

响应

响应头

此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。

响应体

该响应体返回为 application/json 数据,包含完整节点数据的内容展示如下:
{
"RequestId": "",
"Code": 0,
"StatusCode": 200,
"Message": "ok",
"Data": {
"TaskId": "9b8f5bb43d92c3865bc9d541e54f6804",
"TaskName": "name",
"StartTime": 1658973728,
"EndTime": 1658973828,
"Mode": 1,
"Expiration": 10,
"Status": 1,
"Capacity": 64
}
}
字段名
类型
描述
备注
RequestId
string
请求 ID
-
Code
int
状态码,0 成功,500 操作失败
-
StatusCode
int
错误码,200 OK,其他详见错误中心
-
Message
string
返回信息
-
Data
object
返回结果
-
Data
字段名
类型
描述
备注
TaskId
string
任务 ID
-
TaskName
string
任务名称
-
StartTime
timestamp
取回录像的开始时间
-
EndTime
timestamp
取回录像的结束时间
-
Mode
int
取回模式
1:极速模式,其他暂不支持
Expiration
int
副本有效期
-
Status
int
任务状态
0:已取回,1:取回中,2:待取回
Capacity
float
取回容量,单位 MB
-