修改录像上云计划

最近更新时间:2023-05-04 17:43:16

我的收藏

功能描述

用于修改录像上云计划。


请求

请求url

POST /ivc/recordbackup/plan/modify

请求参数

此接口无请求参数。


请求头

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


请求体

该请求操作的实现需要有如下请求体。

{
"PlanId": "0cb923xxxxxxxxxxxxxxxxxxxx9ebbaa",
"Mod": {
"PlanName": "name",
"TemplateId": "48676exxxxxxxxxxxxxxxxxxxx220fa4",
"Describe": "",
"LifeCycle": {
"Transition": 10,
"Expiration": 60
},
"Add": [
{
"DeviceId": "1c43487d-cd8d-4892-989a-2f31f88d6bcd",
"ChannelId": "90953ced-04ea-4baa-bf37-053e2e86e313"
},
{
"DeviceId": "",
"ChannelId": ""
}
],
"Del": [
"1c43487d-cd8d-4892-989a-2f31f88d6bcd",
"1c43487d-cd8d-4892-989a-2f31f88da43"
],
"OrganizationId" : [ "1", "2", "3"]
}
}

字段名
类型
描述
必须
备注
PlanId
string
计划id
-
Mod
object
修改的内容
-
Mod

字段名
类型
描述
必须
备注
PlanName
string
录像计划名称
仅支持中文、英文、数字、_、-,长度不超过32个字符,计划名称全局唯一,不能为空,不能重复,不修改名称时,不需要该字段
TemplateId
string
录制模板id
不修改模板id时,不需要该字段
Describe
string
录像计划描述
仅支持中文、英文、数字、_、-,长度不超过128个字符, 不修改描述时,不需要该字段
LifeCycle
object
生命周期
录像文件生命周期设置,管理文件冷、热存储的时间,不修改生命周期时,不需要该字段
Add
object
要新增的设备通道
Json数组,没有新增时,不需要该字段,一次添加通道总数不超过5000个,包括组织目录下的通道数量
Del
object
要删除的设备通道
Json数组,内容为要删除的设备通道id,没有删除设备通道时,不需要该字段
OrganizationId
object
添加组织目录下所有设备通道
Json数组,可以为空,并且通道总数量不超过5000个(包括Add字段通道数量)
LifeCycle

字段名
类型
描述
必须
备注
Transition
int
录像文件热存储时长
单位天,最小1天,最大3650天
Expiration
int
录像文件冷存储时长
单位天,0表示不设置,设置时最小60天,最大3650天
Add

字段名
类型
描述
必须
备注
DeviceId
string
通道所属的设备id
-
ChannelId
string
设备通道id
-

响应

响应头

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


响应体

该响应体返回为 application/json 数据,包含完整节点数据的内容展示如下:

{
"RequestId": "MTg3NmEzYWE0ZWNfN2ExYWFmMWVfMF84NA==",
"Code": 0,
"StatusCode": 200,
"Message": "ok",
"Data": {
"PlanId": "70c4720b-6c80-456d-8b76-0ca457526f67",
"PlanName": "aaaaaa",
"Describe": "1231",
"TemplateId": "be3bd606-1de7-4c29-917e-57bcf9adeb73",
"LifeCycle": {
"Transition": 0,
"Expiration": 0
},
"Status": 1,
"StreamType": "",
"ChannelCount": 0,
"CreateAt": "2023-03-31 17:16:14",
"UpdateAt": "2023-04-07 14:52:55"
}
}

字段名
类型
描述
备注
RequestId
string
请求id
-
Code
int
状态码,0 成功,500 操作失败
-
StatusCode
int
错误码,200 OK,其他详见错误中心
-
Message
string
返回信息
-
Data
object
返回结果
-
Data
字段名
类型
描述
备注
PlanId
string
录像计划id
-
PlanName
string
录像计划名称
-
TemplateId
string
录制模板id
-
Describe
string
录像计划描述
-
LifeCycle
object
生命周期
录像文件生命周期设置,管理文件冷、热存储的时间
LifeCycle
字段名
类型
描述
备注
Transition
int
录像文件热存储时长
单位天,最小1天,最大3650天
Expiration
int
录像文件冷存储时长
单位天,0表示不设置,设置时最小60天,最大3650天