功能描述
用于新增实时上云计划。
请求
请求url
POST /ivc/record/plan/add
请求参数
此接口无请求参数。
请求头
请求体
该请求操作的实现需要有如下请求体。
{"PlanName": "name","TemplateId": "48676e89a8c19a8728896baa36220fa4","Describe": "","StreamType" : "main","LifeCycle": {"Transition": 1,"Expiration": 60},"Channels": [{"DeviceId": "7f7a3f2b-f150-45ae-821e-9b8906e7d8a9","ChannelId": "1c43487d-cd8d-4892-989a-2f31f88d6bcd"},{"DeviceId": "","ChannelId": ""}],"OrganizationId" : [ "1", "2", "3"]}
字段名 | 类型 | 描述 | 必须 | 备注 |
TemplateId | string | 上云模板id | 是 | 上云计划关联的模板id |
PlanName | string | 上云计划名称 | 是 | 仅支持中文、英文、数字、_、-，长度不超过32个字符，计划名称全局唯一，不能为空，不能重复 |
Describe | string | 上云计划描述 | 否 | 仅支持中文、英文、数字、_、-，长度不超过128个字符 |
StreamType | string | 码流类型 | 否 | default:不指定码流类型，以设备默认推送类型为主， main:主码流，sub:子码流，其他根据设备能力集自定义，不填按默认类型处理 |
LifeCycle | object | 生命周期 | 是 | 云文件生命周期设置，管理文件冷、热存储的时间 |
Channels | object | 通道及通道所属设备 | 否 | 添加录像的设备的通道信息，一次添加通道总数不超过5000个，包括组织目录下的通道数量 |
OrganizationId | object | 添加组织目录下所有设备通道 | 否 | Json数组，可以为空，通道总数量不超过5000个（包括Channel字段的数量） |
LifeCycle
字段名 | 类型 | 描述 | 必须 | 备注 |
Transition | int | 云文件热存储时长 | 是 | 单位天，最小1天，最大3650天 |
Expiration | int | 云文件冷存储时长 | 是 | 单位天，0表示不设置，设置时最小60天，最大3650天 |
Channels
字段名 | 类型 | 描述 | 必须 | 备注 |
DeviceId | string | 通道所属的设备id | 是 | - |
ChannelId | string | 设备通道id | 是 | 一个设备通道只允许被一个上云计划添加 |
响应
响应头
响应体
该响应体返回为 application/json 数据，包含完整节点数据的内容展示如下：
{"RequestId": "","Code": 0,"StatusCode": 200,"Message": "ok","Data": {"PlanId": "0cb923ffe360fb8225b9d3e70e9ebbaa","PlanName": "name","TemplateId": "48676e89a8c19a8728896baa36220fa4","Describe": ""}}
字段名 | 类型 | 描述 | 备注 |
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 | 上云计划描述 | - |
