智能视图计算平台数据结构

AddDeviceData

增加设备接口返回数据

被如下接口引用：AddUserDevice。

名称	类型	描述
DeviceId	String	设备iD 示例值：f8656fa3-e7fa-4cad-a4cc-********
Code	String	设备编码（国标设备即我们为设备生成的20位国标编码，rtmp 设备为10 位设备编码）示例值：6101320000132000****
Name	String	设备名称示例值：设备1
AccessProtocol	Integer	设备接入协议，1:RTMP,2:GB,3:GW 示例值：3
Type	Integer	设备类型，1:IPC,2:NVR 示例值：1
ClusterId	String	设备接入服务节点ID 示例值：b2181417-03ce-4ea3-ae39-********
ClusterName	String	设备接入服务节点名称示例值：上海1
TransportProtocol	Integer	设备流传输协议，1:UDP,2:TCP 示例值：1
Password	String	设备密码示例值：111111
Description	String	设备描述示例值：这个是gw设备
Status	Integer	设备状态，0:未注册,1:在线,2:离线,3:禁用示例值：1
OrganizationId	Integer	设备所属组织ID 示例值：237
GatewayId	String	设备接入网关ID，从查询网关列表接口中获取（仅网关接入需要）示例值：f6d2540d-1d13-4873-b10e-********
ProtocolType	Integer	网关接入协议类型，1.海康SDK，2.大华SDK，3.宇视SDK，4.Onvif（仅网关接入需要）示例值：1
Ip	String	设备接入IP（仅网关接入需要）示例值：192.168.**.1
Port	Integer	设备Port（仅网关接入需要）示例值：9000
Username	String	设备用户名（仅网关接入需要）示例值：admin
AppId	Integer	用户ID 示例值：130****012

AddOrgData

增加组织接口返回数据

被如下接口引用：AddOrganization。

名称	类型	描述
OrganizationId	String	组织 ID 示例值：237
Name	String	组织名称示例值：组织1
ParentId	String	组织父节点 ID 示例值：236
Level	Integer	组织层级示例值：3
AppId	Integer	用户ID 示例值：1300***012
ParentIds	String	组织结构示例值：0,236
Total	Integer	设备总数示例值：10
Online	Integer	设备在线数量示例值：6

AddRecordBackupPlanData

新增录像上云计划返回数据

被如下接口引用：AddRecordBackupPlan。

名称	类型	描述
PlanId	String	录像上云计划ID 示例值：f06d500f-64fb-42c0-b804-********
PlanName	String	录像上云计划名称示例值：录像上云计划1
TemplateId	String	录像上云模板ID 示例值：584fd9d0-569c-4153-aff7-********
Describe	String	录像上云计划描述示例值：这是计划1
LifeCycle	LifeCycleData	云文件生命周期
Status	Integer	录像上云计划状态，1:正常使用中，0:删除中，无法使用示例值：1
ChannelCount	Integer	通道数量示例值：10
CreateAt	String	创建时间示例值：2023-09-06 15:52:34
UpdateAt	String	修改时间示例值：2023-09-06 15:52:34

AddRecordBackupTemplateData

新增录像上云模板返回数据

被如下接口引用：AddRecordBackupTemplate。

名称	类型	描述
TemplateId	String	模板ID 示例值：584fd9d0-569c-4153-aff7-********
TemplateName	String	模板名称示例值：模板1
TimeSections	Array of RecordTemplateTimeSections	上云时间段（按周进行设置，支持一天设置多个时间段，每个时间段不小于10分钟）
DevTimeSections	Array of RecordTemplateTimeSections	录像时间段（按周进行设置，支持一天设置多个时间段，每个时间段不小于10分钟）
Scale	Integer	上云倍速（支持1，2，4倍速）示例值：2
CreateAt	String	创建时间示例值：2023-09-06 15:52:34
UpdateAt	String	更新时间示例值：2023-09-06 15:52:34
DayOffset	Integer	周期偏移量，默认1，表示拉取昨天的设备录像，0表示取去今天的设备录像，3表示拉取前天的设备录像默认值：1 示例值：1

AddRecordRetrieveTaskData

查询取回任务详情返回数据

被如下接口引用：AddRecordRetrieveTask。

名称	类型	描述
TaskId	String	任务ID 示例值：d00a3e6f9b9*40cebcee7a6
TaskName	String	任务名称示例值：1月23号取回
StartTime	Integer	取回录像的开始时间示例值：1687688595
EndTime	Integer	取回录像的结束时间示例值：1687692195
Mode	Integer	取回模式，1:极速模式，其他暂不支持示例值：1
Expiration	Integer	副本有效期示例值：3
Status	Integer	任务状态，0:已取回，1:取回中，2:待取回示例值：0
Capacity	Float	取回容量，单位MB 示例值：100
Describe	String	任务描述示例值：大门口通道取回

AddStreamAuthData

设置推拉流鉴权返回数据结构

被如下接口引用：AddStreamAuth。

名称	类型	描述
Id	String	鉴权配置ID（uuid）示例值：e8317c5b-7087-4126-bca0-********
PullState	Integer	是否开播放鉴权（1:开启,0:关闭）示例值：1
PullSecret	String	播放密钥（仅支持字母数字，长度0-10位）示例值：aaaaaa
PullExpired	Integer	播放过期时间（单位：分钟）示例值：10
PushState	Integer	是否开启推流鉴权（1:开启,0:关闭）示例值：1
PushSecret	String	推流密钥（仅支持字母数字，长度0-10位）示例值：bbbbbb
PushExpired	Integer	推流过期时间（单位：分钟）示例值：10
AppId	Integer	用户ID 示例值：1300***012

BatchOperateDeviceData

批量操作设备返回结果

被如下接口引用：BatchOperateDevice。

名称	类型	描述
TaskId	String	任务 ID（用于在查询任务的子任务列表接口ListSubTasks中查询任务进度）示例值：----******

BitRateInfo

视频通道码率返回结果

被如下接口引用：DescribeVideoBitRate。

名称	类型	描述
ChannelId	String	通道Id 示例值："ffefbe2f--4659--7596****13900"
Bitrate	Float	码率,单位:kbps 示例值：15.23

ChannelAttrInfo

通道属性信息

被如下接口引用：QueryForbidPlayChannelList。

名称	类型	描述
DeviceId	String	设备通道所属的设备ID 示例值：389708b2-bcbb-********-a61f528b2a15
DeviceName	String	设备通道所属的设备名称示例值：NVR05
ChannelId	String	设备通道ID 示例值：53ca64d3-9627-********-cea5122f6977
ChannelName	String	设备通道名称示例值：PTZ03

ChannelInfo

通道及通道所属设备信息

被如下接口引用：AddRecordBackupPlan, AddRecordPlan, AddRecordRetrieveTask, UpdateRecordBackupPlan, UpdateRecordPlan。

名称	类型	必选	描述
DeviceId	String	是	通道所属的设备ID 示例值：f8656fa3-e7fa-4cad-a4cc-********
ChannelId	String	是	设备通道ID，一个设备通道只允许被一个上云计划添加示例值：f7ca505f-be1b-4ce8-849b-********

ControlDeviceStreamData

获取开流地址返回数据

被如下接口引用：ControlDeviceStream。

名称	类型	描述
Flv	String	flv 流地址示例值：https://www.demo.com/live/f7ca505f-be1b-4ce8-849b-************.live.flv
Hls	String	hls 流地址示例值：https://www.demo.com/live/f7ca505f-be1b-4ce8-849b-************/hls.m3u8
Rtmp	String	rtmp 流地址示例值：rtmp://www.demo.com/live/f7ca505f-be1b-4ce8-849b-********

DescribeDeviceAddrList

查询国标设备地址列表

被如下接口引用：DescribeGBDeviceAddr。

名称	类型	描述
RemoteAddrs	Array of RemoteAddrInfo	设备地址列表示例值：[{"DeviceId":"ffefbe2f--4659--7596****139", "Addr":"127.0.0.1"}]

DescribeDeviceChannelData

查询设备通道信息返回结果

被如下接口引用：DescribeDeviceChannel。

名称	类型	描述
DeviceId	String	设备 ID 示例值：f8656fa3-e7fa-4cad-a4cc-********
ChannelId	String	通道 ID 示例值：f7ca505f-be1b-4ce8-849b-********
ChannelCode	String	通道编码示例值：6101000000131000****
Name	String	通道名称示例值：通道1
Status	Integer	流状态（0:未传输,1:传输中）示例值：1
PTZType	Integer	是否可控 Ptz（0:不可控,1:可控）示例值：0
Manufacturer	String	通道厂商示例值：Hikvison
Resolution	String	通道支持分辨率（分辨率列表由‘/’隔开，国标协议样例（6/3），自定义样例（12800960/640480））示例值：6/3
State	Integer	通道在离线状态（0:离线,1:在线）示例值：1
Region	String	所在地域示例值：ap-shanghai

DescribeDeviceData

查询设备接口返回数据

被如下接口引用：DescribeUserDevice, DescribeUserDeviceList。

名称	类型	描述
DeviceId	String	设备ID 示例值：f8656fa3-e7fa-4cad-a4cc-********
Code	String	设备编码（国标设备即我们为设备生成的20位国标编码，rtmp 设备为10 位设备编码）示例值：6101320000132000****
Name	String	设备名称示例值：设备1
AccessProtocol	Integer	设备接入协议，1:RTMP,2:GB,3:GW 示例值：2
Type	Integer	设备类型，1:IPC,2:NVR 示例值：1
ClusterId	String	设备接入服务节点id 示例值：b2181417-03ce-4ea3-ae39-********
ClusterName	String	设备接入服务节点名称示例值：上海1
TransportProtocol	Integer	设备流传输协议，1:UDP,2:TCP 示例值：1
Password	String	设备密码示例值：zxczxc
Description	String	设备描述示例值：这是个设备
SipId	String	sip服务ID 示例值：7101000000200000****
SipDomain	String	sip服务域示例值：7101000000
SipIp	String	sip服务IP地址示例值：88.88.88.88
SipPort	Integer	sip服务端口示例值：5870
PushStreamUrl	String	Rtmp设备推流地址(仅rtmp设备有效) 示例值：rtmp://88.88.88.88/live/I3Pocd****
Status	Integer	设备状态，0:未注册,1:在线,2:离线,3:禁用示例值：1
OrganizationId	String	设备所属组织ID 示例值：237
GatewayId	String	设备接入网关ID，从查询网关列表接口中获取（仅网关接入需要）示例值：f6d2540d-1d13-4873-b10e-********
GatewayName	String	设备所属网关名称示例值：网关1
ProtocolTypeName	String	设备网关协议名称示例值：Onvif
ProtocolType	Integer	网关接入协议类型，1.海康SDK，2.大华SDK，3.宇视SDK，4.Onvif（仅网关接入需要）示例值：4
Ip	String	设备接入IP 示例值：192.168.*.1
Port	Integer	设备Port 示例值：9000
Username	String	设备用户名示例值：admin
Region	String	设备地域示例值：ap-shanghai
Manufacturer	String	设备厂商示例值：Hikvision
AudioSwitch	Integer	音频关开（0：关闭；1：开启）关闭时丢弃音频示例值：0
SubscribeSwitch	Integer	订阅开关（0：关闭；1：开启）默认开启，开启状态下会订阅设备通道变化，仅国标NVR设备有效示例值：1
AppName	String	RTMP推流地址自定义appName 示例值：live
StreamName	String	RTMP推流地址自定义streamName 示例值：00cuDZBadN
SilentFrameSwitch	Integer	是否开启静音帧（0：关闭；1 开启）示例值：0
PushStreamSecureUrl	String	Rtmp设备安全认证推流地址(仅rtmp设备有效) 示例值：rtmps://rtmp.live.com:11935/live/I3Pocdaeq

DescribeDeviceListData

批量查询设备接口返回数据

被如下接口引用：DescribeUserDeviceList。

名称	类型	描述
List	Array of DescribeDeviceData	设备详情列表示例值：

DescribeDevicePresetData

查询设备预置位返回数据

被如下接口引用：DescribeDevicePreset。

名称	类型	描述
Index	Integer	预置位索引只支持1-10的索引示例值：1
Name	String	预置位名称示例值：预置位1

DescribeDeviceRegion

查询设备可接入集群信息

被如下接口引用：DescribeDeviceRegion。

名称	类型	描述
Label	String	服务节点描述示例值：上海1
Value	String	服务节点 ID（对应为其他接口中所需的 ClusterId）示例值：b2181417-03ce-4ea3-ae39-********
Region	String	地域信息示例值：ap-shanghai

DescribeDomainData

查询域名详情数据

被如下接口引用：DescribeDomain。

名称	类型	描述
Id	String	域名ID 示例值：2d203ed6-c0e9-4ef0-817b-********
PlayDomain	String	播放域名示例值：www.demo.com
InternalDomain	String	CNAME 记录值示例值：d0bf30383016f5ac52aff**.play-*.ap-shanghai.tencentiss.cn
HaveCert	Integer	是否上传证书（0：否，1：是）示例值：1
ClusterId	String	服务节点 ID 示例值：b2181417-03ce-4ea3-ae39-********
ClusterName	String	服务节点名称示例值：上海1
AppId	Integer	用户ID 示例值：130****012
CertId	String	证书ID 示例值：AI9C****
DomainType	Integer	域名类型 0:拉流域名 1:推流域名示例值：0

DescribeDomainRegionData

查询域名可绑定集群数据

被如下接口引用：DescribeDomainRegion。

名称	类型	描述
Label	String	服务节点描述示例值：上海1
Value	String	服务节点 ID（对应为其他接口中所需的 ClusterId）示例值：b2181417-03ce-4ea3-ae39-********
Region	String	地域信息示例值：ap-shanghai

DescribeOrganizationData

查询组织数据返回结果

被如下接口引用：DescribeOrganization。

名称	类型	描述
OrganizationId	String	组织 ID 示例值：237
Name	String	组织名称示例值：组织237
ParentId	String	组织父节点 ID 示例值：236
Level	Integer	组织层级示例值：3
AppId	Integer	用户id 示例值：1300***012
ParentIds	String	组织结构示例值：0,236
Total	Integer	设备总数示例值：10
Online	Integer	设备在线数量示例值：8

DescribeRecordBackupPlanData

查询录像上云计划返回数据

被如下接口引用：DescribeRecordBackupPlan。

名称	类型	描述
PlanId	String	录像上云计划ID 示例值：f06d500f-64fb-42c0-b804-********
PlanName	String	录像上云计划名称示例值：计划1
TemplateId	String	录像上云模板ID 示例值：584fd9d0-569c-4153-aff7-********
Describe	String	录像上云计划描述示例值：这是一个录像上云计划
LifeCycle	LifeCycleData	云文件生命周期
Status	Integer	录像上云计划状态，1:正常使用中，0:删除中，无法使用示例值： 1
ChannelCount	Integer	通道数量示例值：10
CreateAt	String	创建时间示例值：2023-09-06 15:52:34
UpdateAt	String	修改时间示例值：2023-09-06 15:52:34

DescribeRecordBackupTemplateData

查询录像上云模板返回数据

被如下接口引用：DescribeRecordBackupTemplate。

名称	类型	描述
TemplateId	String	模板ID 示例值：584fd9d0-569c-4153-aff7-********
TemplateName	String	模板名称示例值：录像备份模板1
TimeSections	Array of RecordTemplateTimeSections	上云时间段（按周进行设置，支持一天设置多个时间段，每个时间段不小于10分钟）
DevTimeSections	Array of RecordTemplateTimeSections	录像时间段（按周进行设置，支持一天设置多个时间段，每个时间段不小于10分钟）
Scale	Integer	上云倍速（支持1，2，4倍速）示例值：2
CreateAt	String	创建时间示例值：2023-09-06 15:52:34
UpdateAt	String	更新时间示例值：2023-09-06 15:53:34
DayOffset	Integer	周期偏移量，默认1，表示拉取昨天的设备录像，0表示取去今天的设备录像，3表示拉取前天的设备录像示例值：1

DescribeRecordFileData

用于查询设备云端录像时间轴信息返回数据

被如下接口引用：DescribeRecordFile。

名称	类型	描述
Tips	Integer	提示类型，0:时间段内无归档录像，1:时间段内有归档录像示例值：0
List	Array of RecordTimeLine	存在为数组格式，不存在字段内容为空注意：此字段可能返回 null，表示取不到有效值。

DescribeRecordRetrieveTaskData

查询云录像取回任务详情返回数据

被如下接口引用：DescribeRecordRetrieveTask。

名称	类型	描述
TaskId	String	取回任务ID 示例值：d00a3e6f9b**040cebcee7a6
TaskName	String	取回任务名称示例值：mane2
StartTime	Integer	取回录像的开始时间示例值：1687688595
EndTime	Integer	取回录像的结束时间示例值：1687692195
Mode	Integer	取回模式，1:极速模式，其他暂不支持示例值：1
Expiration	Integer	副本有效期示例值：3
Status	Integer	任务状态，0:已取回，1:取回中，2:待取回示例值：0
Capacity	Float	取回容量，单位MB 示例值：100
Channels	Array of RecordRetrieveTaskChannelInfo	任务的设备通道id
Describe	String	任务描述示例值：取回8小时
ChannelCount	Integer	任务通道数量示例值：1

DescribeStreamAuthData

查询推拉流鉴权返回数据结构

被如下接口引用：DescribeStreamAuth。

名称	类型	描述
Id	String	鉴权配置ID（uuid）示例值：e8317c5b-7087-4126-bca0-********
PullState	Integer	是否开播放鉴权（1:开启,0:关闭）示例值：1
PullSecret	String	播放密钥（仅支持字母数字，长度0-10位）示例值：abcdefg
PullExpired	Integer	播放过期时间（单位：分钟）示例值：10
PushState	Integer	是否开启推流鉴权（1:开启,0:关闭）示例值：1
PushSecret	String	推流密钥（仅支持字母数字，长度0-10位）示例值：abcdefg
PushExpired	Integer	推流过期时间（单位：分钟）示例值：10
AppId	Integer	用户ID 示例值：1300***012

DescribeVideoBitRateList

查询视频通道码率的返回结果列表

被如下接口引用：DescribeVideoBitRate。

名称	类型	描述
BitRates	Array of BitRateInfo	通道码率列表示例值：[{"ChannelId":"ffefbe2f--4659--7596****139", "Bitrate":15.23}]

DescribeVideoDownloadUrlData

获取云录像下载URL返回的数据

被如下接口引用：DescribeVideoDownloadUrl。

名称	类型	描述
Url	String	录像文件下载 URL 注意： URL 有效期是10分钟，过期后将拒绝访问，若需再用请重新获取录像文件下载采用分块传输编码，响应头Transfer-Encoding:chunked 下载文件命名格式为{ChannelId}-{BeginTime}-{EndTime}.{FileType} 示例值：https://.cn/vds/video.mp4?source=00037e5f-2aaa---f30b13a86b02%3B1700546401%3B1700546461%3Bmp4&res=7f4f9b9d635fad97c589bc1e02&expires=600&signTime=1706151234&sign=*959fc5de6afe16
ActualBeginTime	String	实际下载录像的开始时间注意：当请求中指定IsRespActualTime参数为true时，才有该字段示例值：1700546401
ActualEndTime	String	实际下载录像的结束时间注意：当请求中指定IsRespActualTime参数为true时，才有该字段示例值：1700546461

GBDeviceSnapInfo

抓拍结果信息

被如下接口引用：ListDeviceSnapshots。

名称	类型	描述
FileName	String	文件名称示例值：snap01.jpg
DownloadUrl	String	下载地址，空值表示存储图片过期示例值：https://xxx
ImageSize	Integer	图片大小，单位B 示例值：2048
CreatedTime	String	文件的创建时间示例值：2025-01-30 15:20:00
ReceivedTime	String	图片的接收时间示例值：2025-01-30 15:20:00
PreviewUrl	String	预览地址，空值表示存储图片过期示例值：https://xxx
SessionId	String	国标信令会话ID，同时对应控制设备抓拍 ( ControlDeviceSnapshot )接口返回的request_id 示例值：14234c44--4a0c--daa7ea****c2a

ISAPIOutputData

ISUP智能安全接入 API返回数据

被如下接口引用：CallISAPI。

名称	类型	描述
OutputData	String	输出参数示例值：<?xml version="1.0"?>\n

LifeCycleData

生命周期，云文件生命周期设置，管理文件冷、热存储的时间

被如下接口引用：AddRecordBackupPlan, AddRecordPlan, DescribeRecordBackupPlan, DescribeRecordPlan, ListRecordBackupPlans, ListRecordPlans, UpdateRecordBackupPlan, UpdateRecordPlan。

名称	类型	必选	描述
Transition	Integer	是	云文件热存储时长，单位天，最小1天，最大3650天示例值：7
Expiration	Integer	是	云文件冷存储时长，单位天，0表示不设置，设置时最小60天，Expiration字段加Transition字段不超过3650天示例值：90

ListDeviceInfo

获取设备列表的响应

被如下接口引用：ListDevices。

名称	类型	描述
DeviceId	String	设备 ID 示例值：f8656fa3-e7fa-4cad-a4cc-****
Code	String	设备编码示例值：6101320000132000****
Status	Integer	设备状态。0:未注册，1:在线，2:离线，3:禁用示例值：1
TransportProtocol	Integer	设备流传输协议。1:UDP,2:TCP 示例值：2
Name	String	设备名称示例值：设备1
Type	Integer	设备类型。1:IPC,2:NVR 示例值：2
Password	String	设备密码示例值：53*91
Description	String	描述示例值：这个是GB设备
ClusterId	String	设备接入服务节点 ID 示例值：b2181417-03ce-4ea3-ae39-****
ClusterName	String	服务节点名称示例值：上海1
AccessProtocol	Integer	接入协议。1:RTMP,2:GB,3:GW 示例值：2
OrganizationId	String	设备所属组织 ID 示例值：0
ChannelNum	Integer	通道数量示例值：2

ListForbidplayChannelsData

用户禁止播流的通道列表返回数据

被如下接口引用：QueryForbidPlayChannelList。

名称	类型	描述
PageNumber	Integer	第几页示例值：1
PageSize	Integer	当前页的设备数量示例值：10
TotalCount	Integer	本次查询的设备通道总数示例值：100
List	Array of ChannelAttrInfo	设备通道信息列表注意：此字段可能返回 null，表示取不到有效值。

ListOrganizationChannelNumbersData

组织目录下的未添加到实时上云计划中的通道数量返回数据

被如下接口引用：ListOrganizationChannelNumbers。

名称	类型	描述
TotalCount	Integer	组织下通道总数示例值：20
NotInPlanCount	Integer	组织下未添加到计划的通道总数示例值：5

ListOrganizationChannelsData

查询组织目录下的通道列表返回数据

被如下接口引用：ListOrganizationChannels。

名称	类型	描述
PageNumber	Integer	第几页示例值：1
PageSize	Integer	当前页的设备数量示例值：10
TotalCount	Integer	本次查询的设备通道总数示例值：100
List	Array of OrganizationChannelInfo	设备通道信息列表注意：此字段可能返回 null，表示取不到有效值。

ListRecordBackupPlanData

查询录像上云计划列表返回数据

被如下接口引用：ListRecordBackupPlans。

名称	类型	描述
PlanId	String	录像上云计划ID 示例值：f06d500f-64fb-42c0-b804-********
PlanName	String	录像上云计划名称示例值：录像上云计划1
TemplateId	String	录像上云模板ID 示例值：584fd9d0-569c-4153-aff7-********
Describe	String	录像上云计划描述示例值：这是计划的一部分
LifeCycle	LifeCycleData	云文件生命周期
Status	Integer	录像上云计划状态，1:正常使用中，0:删除中，无法使用示例值： 1
ChannelCount	Integer	通道数量示例值：10
CreateAt	String	创建时间示例值：2023-09-06 15:52:34
UpdateAt	String	修改时间示例值：2023-09-06 15:52:34

ListRecordBackupPlanDevicesData

查询录像上云计划关联通道的返回数据

被如下接口引用：ListRecordBackupPlanDevices。

名称	类型	描述
PageNumber	Integer	第几页示例值：1
PageSize	Integer	当前页的设备数量示例值：20
TotalCount	Integer	本次查询的设备通道总数示例值：10
List	Array of RecordPlanChannelInfo	设备通道信息列表注意：此字段可能返回 null，表示取不到有效值。

ListRecordBackupTemplatesData

查询录像上云模板列表返回数据

被如下接口引用：ListRecordBackupTemplates。

名称	类型	描述
TemplateId	String	模板ID 示例值：584fd9d0-569c-4153-aff7-********
TemplateName	String	模板名称示例值：录像上云模板1
TimeSections	Array of RecordTemplateTimeSections	上云时间段（按周进行设置，支持一天设置多个时间段，每个时间段不小于10分钟）
DevTimeSections	Array of RecordTemplateTimeSections	录像时间段（按周进行设置，支持一天设置多个时间段，每个时间段不小于10分钟）
Scale	Integer	上云倍速（支持1，2，4倍速）示例值：2
CreateAt	String	创建时间示例值：2023-09-06 15:52:34
UpdateAt	String	更新时间示例值：2023-09-06 15:52:34
DayOffset	Integer	周期偏移量，默认1，表示拉去昨天的，0表示拉去今天的，3表示拉去前天的示例值：1

ListRecordPlanChannelsData

用户下所有实时上云计划中的通道id列表返回数据

被如下接口引用：ListRecordPlanChannels。

名称	类型	描述
List	Array of String	用户所有计划下通道id，存在通道是为数组格式，不存在时，字段数据为空注意：此字段可能返回 null，表示取不到有效值。示例值：f7ca505f-be1b-4ce8-849b-********

ListRecordPlanDevicesData

云计划下的设备通道列表返回数据

被如下接口引用：ListRecordPlanDevices。

名称	类型	描述
PageNumber	Integer	第几页示例值：1
PageSize	Integer	当前页的设备数量示例值：10
TotalCount	Integer	本次查询的设备通道总数示例值：100
List	Array of RecordPlanChannelInfo	设备通道信息列表注意：此字段可能返回 null，表示取不到有效值。

ListSubTasksData

列举子任务列表

被如下接口引用：ListSubTasks。

名称	类型	描述
List	Array of SubTaskData	子任务列表
TotalCount	Integer	子任务数量示例值：10

ListTasksData

查询任务列表

被如下接口引用：ListTasks。

名称	类型	描述
List	Array of TaskData	任务列表
TotalCount	Integer	任务数量示例值：10

ListVideoDownloadTaskData

本地录像下载任务列表

被如下接口引用：ListVideoDownloadTask。

名称	类型	描述
List	Array of VideoDownloadTask	任务列表
TotalCount	Integer	任务总数示例值：100

OrganizationChannelInfo

组织目录下的通道信息

被如下接口引用：ListOrganizationChannels。

名称	类型	描述
DeviceId	String	设备通道所属的设备ID 示例值：389708b2-bcbb-********-a61f528b2a15
DeviceName	String	设备通道所属的设备名称示例值：NVR05
ChannelId	String	设备通道ID 示例值：53ca64d3-9627-********-cea5122f6977
ChannelName	String	设备通道名称示例值：PTZ03
InPlan	Boolean	该通道是否在上云计划中，如果是，则不能在添加到其他上云计划\|true：在上云计划中，false：不在上云计划中示例值：true

PlayRecordData

本地录像播放url数据结构

被如下接口引用：PlayRecord。

名称	类型	描述
Flv	String	录像播放地址示例值：http://192.168.0.1:18080/live/5c46860f-**-41bd--a5e47cab08df@c451066b--46ba-**-53fc3c7c1d7c.live.flv?start=1656604800&end=1656608400&stream_type=1&resolution=6

RecordPlanBaseInfo

实时上云计划基础信息

被如下接口引用：DescribeRecordPlan, ListRecordPlans。

名称	类型	描述
PlanId	String	上云计划ID 示例值：88ac5ea6c1**224671d0f94f
PlanName	String	上云计划名称示例值：工作日计划
TemplateId	String	上云模板ID 示例值：9ee325e9984b**805c19b4e1
Describe	String	上云计划描述示例值：工作日计划
StreamType	String	码流类型，default:设备默认码流类型，main:主码流，sub:子码流，其他根据设备能力集自定义示例值：main
LifeCycle	LifeCycleData	云文件生命周期
Status	Integer	录像计划状态，1:正常使用中，0:删除中，无法使用示例值：1
ChannelCount	Integer	通道总数示例值：10
RepairMode	Integer	录像补录模式（0:不启用，1:启用）示例值：0

RecordPlanChannelInfo

计划下的设备通道信息

被如下接口引用：ListRecordBackupPlanDevices, ListRecordPlanDevices。

名称	类型	描述
DeviceId	String	设备通道所属的设备ID 示例值：cae2132a-7edc-********-19cc90a61f06
DeviceName	String	设备通道所属的设备名称示例值：NVR05
ChannelId	String	设备通道ID 示例值：15daac41-f309-********-0cadab7a6256
ChannelName	String	设备通道名称示例值：ptz01
OrganizationName	String	所属组织名称示例值：深圳市
AccessProtocol	Integer	通道所属设备的接入协议类型示例值：2

RecordPlanOptData

实时上云计划添加和修改的返回数据

被如下接口引用：AddRecordPlan, UpdateRecordPlan。

名称	类型	描述
PlanId	String	上云计划ID 示例值：88ac5ea6c1**224671d0f94f
PlanName	String	上云计划名称示例值：name1
TemplateId	String	上云模板ID 示例值：9ee325e9984b**805c19b4e1
Describe	String	上云计划描述示例值：工作日计划
LifeCycle	LifeCycleData	云文件生命周期
StreamType	String	码流类型，default:设备默认码流类型，main:主码流，sub:子码流，其他根据设备能力集自定义示例值：main
RepairMode	Integer	录像补录模式（0:不启用，1:启用）示例值：0

RecordPlaybackUrl

云录像回放url

被如下接口引用：DescribeRecordPlaybackUrl。

名称	类型	描述
Hls	String	hls回放url 示例值：https://test5.maxshang.cn/playback/32525dd7-c3fc-**--d5beb4acd1e1/hls.m3u8?starttime=1687677795&endtime=1687688595&token=13*****2_1687677842_68dfc39854510520f29de4da78bd6e93

RecordRetrieveTaskChannelInfo

取回任务通道信息

被如下接口引用：DescribeRecordRetrieveTask。

名称	类型	描述
DeviceId	String	设备通道所属的设备ID 示例值：389708b2-bcbb-********-a61f528b2a15
DeviceName	String	设备通道所属的设备名称示例值：SDK-NVR05
ChannelId	String	设备通道ID 示例值：32525dd7-c3fc-********-d5beb4acd1e1
ChannelName	String	设备通道名称示例值：ptz01
Status	Integer	任务状态，0:已取回，1:取回中，2:待取回, 3:无归档录像示例值：0

RecordRetrieveTaskDetailsInfo

录像取回任务详情基础信息

被如下接口引用：ListRecordRetrieveTasks。

名称	类型	描述
TaskId	String	任务ID 示例值：d00a3e6f9b**040cebcee7a6
TaskName	String	任务名称示例值：取回任务
StartTime	Integer	取回录像的开始时间示例值：1687688595
EndTime	Integer	取回录像的结束时间示例值：1687692195
Mode	Integer	取回模式，1:极速模式，其他暂不支持示例值：1
Expiration	Integer	副本有效期示例值：3
Status	Integer	任务状态， 0:已取回，1:取回中，2:待取回示例值：0
Capacity	Integer	取回容量，单位MB 示例值：100
Describe	String	任务描述示例值：取回任务
ChannelCount	Integer	任务通道数量示例值：1

RecordSliceInfo

录像切片信息

被如下接口引用：DescribeRecordSlice。

名称	类型	描述
PlanId	String	计划ID 示例值：88ac5ea6c1f**24671d0f94f
List	Array of RecordTimeLine	录像切片开始和结束时间列表

RecordTemplateInfo

实时上云模板信息数据

被如下接口引用：AddRecordTemplate, DescribeRecordTemplate, ListRecordTemplates, UpdateRecordTemplate。

名称	类型	描述
TemplateId	String	模板ID 示例值：48676e89a8c**baa36220fa4
TemplateName	String	模板名称示例值：name
TimeSections	Array of RecordTemplateTimeSections	上云时间段，按周进行设置，支持一天设置多个时间段，每个时间段不小于10分钟

RecordTemplateTimeSections

上云模板的时间片段数据格式

被如下接口引用：AddRecordBackupTemplate, AddRecordTemplate, DescribeRecordBackupTemplate, DescribeRecordTemplate, ListRecordBackupTemplates, ListRecordTemplates, UpdateRecordBackupTemplate, UpdateRecordTemplate。

名称	类型	必选	描述
DayOfWeek	Integer	是	周日期，取值范围1～7（对应周一～周日示例值：1
StartTime	String	是	开始时间，格式：HH:MM:SS，范围：[00:00:00～23:59:59] 示例值：08:00:00
EndTime	String	是	结束时间，格式：HH:MM:SS，范围：[00:00:00～23:59:59] 示例值：12:00:00

RecordTimeLine

云录像时间片段

被如下接口引用：DescribeRecordFile, DescribeRecordSlice。

名称	类型	描述
Begin	Integer	时间片段开始时间，UTC秒数，例如：1662114146 示例值：1687688595
End	Integer	时间片段结束时间，UTC秒数，例如：1662114146 示例值：1687692195
HlsUrl	String	对应时间片段的播放url 示例值：https://domain/playback/00037e5f-***-f30b13a86b02/hls.m3u8?starttime=1727164597&endtime=1727164770&token=******

RemoteAddrInfo

设备地址返回结果

被如下接口引用：DescribeGBDeviceAddr。

名称	类型	描述
DeviceId	String	设备Id 示例值："ffefbe2f--4659--7596****13900"
Addr	String	IP地址示例值："127.0.0.1"

SetForbidplayChannelParam

设置通道禁止播流，有通道Id和使能enable字段

被如下接口引用：SetForbidPlayChannels。

名称	类型	必选	描述
ChannelId	String	是	通道Id 示例值：9ee325e9984**a805c19b4e1
Enable	Boolean	是	是否禁止通道播流示例值：true

SubTaskData

子任务详情

被如下接口引用：ListSubTasks。

名称	类型	描述
SubTaskId	String	子任务ID 示例值：9effe2a2-60d3-418b-9546-********
Status	Integer	任务状态1:NEW,2:RUNNING,3:COMPLETED ,4:FAILED 示例值：3
FailReason	String	任务失败原因示例值：设备离线
Progress	Float	任务进度示例值：0.66
Action	String	操作类型示例值：DisableDevice
ActionZhDesc	String	操作类型中文描述示例值：禁用设备
ResourceId	String	资源ID 示例值：f8656fa3-e7fa-4cad-a4cc-********
StartedAt	String	启动任务时间示例值：2023-11-02 10:00:12.324
CreatedAt	String	创建任务时间示例值：2023-11-02 10:00:12.324
UpdatedAt	String	更新任务时间示例值：2023-11-02 10:00:12.334
Runtime	Integer	任务运行时间，单位ms 示例值：20
DeviceId	String	设备ID 示例值：f8656fa3-e7fa-4cad-a4cc-********
DeviceName	String	设备名称示例值：设备1
ChannelId	String	通道ID 示例值：f7ca505f-be1b-4ce8-849b-********
ChannelName	String	通道名称示例值：通道1

TaskData

查询复杂任务详情返回结果

被如下接口引用：DescribeTask, ListTasks。

名称	类型	描述
TaskId	String	任务ID 示例值：4d3535ba-3d81-4154-85ac-********
Status	Integer	任务状态1:NEW,2:RUNNING,3:COMPLETED ,4:FAILED 示例值：3
FailReason	String	失败原因示例值：设备响应超时
Progress	Float	进度（0-1）示例值：1
Action	String	任务操作类型，批量任务类型以Batch开头示例值：BatchDisableDevice
ActionZhDesc	String	操作类型中文描述示例值：批量禁用设备
TaskType	Integer	任务类型 1.简单 2.复杂 3.子任务示例值：2
ResourceId	String	任务资源id（复杂任务该字段无效）示例值：f8656fa3-e7fa-4cad-a4cc-********
Total	Integer	总任务数（仅复杂任务有效）示例值：10
SuccessCount	Integer	成功任务数（仅复杂任务有效）示例值：10
FailCount	Integer	失败任务数（仅复杂任务有效）示例值：0
RunningCount	Integer	运行任务数（仅复杂任务有效）示例值：0
StartedAt	String	启动任务时间示例值：2023-09-06 15:52:34
CreatedAt	String	创建任务时间示例值：2023-09-06 15:52:34
UpdatedAt	String	更新任务时间示例值：2023-09-06 15:52:35
Runtime	Integer	任务运行时间，单位ms 示例值：300
DeviceId	String	设备ID 示例值：f8656fa3-e7fa-4cad-a4cc-********
DeviceName	String	设备名称示例值：设备1
ChannelId	String	通道ID 示例值：f7ca505f-be1b-4ce8-849b-********
ChannelName	String	通道名称示例值：通道1

Timeline

时间片段结构体

被如下接口引用：ControlRecordTimeline。

名称	类型	描述
Begin	Integer	分片起始时间示例值：1702813300
End	Integer	分片结束时间示例值：1702814300

UpdateDeviceData

修改设备接口返回数据

被如下接口引用：UpdateUserDevice。

名称	类型	描述
DeviceId	String	设备ID 示例值：f8656fa3-e7fa-4cad-a4cc-********
Code	String	设备编码（国标设备即我们为设备生成的20位国标编码，rtmp 设备为10 位设备编码）示例值：6101320000132000****
Name	String	设备名称示例值：设备1
AccessProtocol	Integer	设备接入协议，1:RTMP,2:GB,3:GW 示例值：2
Type	Integer	设备类型，1:IPC,2:NVR 示例值：1
ClusterId	String	设备接入服务节点ID 示例值：b2181417-03ce-4ea3-ae39-********
ClusterName	String	设备接入服务节点名称示例值：上海1
TransportProtocol	Integer	设备流传输协议，1:UDP,2:TCP 示例值：2
Password	String	设备密码示例值：111111
Description	String	设备描述示例值：这是一个设备
Status	Integer	设备状态，0:未注册,1:在线,2:离线,3:禁用示例值：1
OrganizationId	Integer	设备所属组织ID 示例值：237
GatewayId	String	设备接入网关ID，从查询网关列表接口中获取（仅网关接入需要）示例值：f6d2540d-1d13-4873-b10e-********
ProtocolType	Integer	网关接入协议类型，1.海康SDK，2.大华SDK，3.宇视SDK，4.Onvif（仅网关接入需要）示例值：1
Ip	String	设备接入IP 示例值：192.168.*.1
Port	Integer	设备Port 示例值：9000
Username	String	设备用户名示例值：admin
AppId	Integer	用户Id 示例值：1300***012

UpdateOrgData

修改组织接口返回数据

被如下接口引用：UpdateOrganization。

名称	类型	描述
OrganizationId	String	组织 ID 示例值：237
Name	String	组织名称示例值：组织237
ParentId	String	组织父节点 ID 示例值：236
Level	Integer	组织层级示例值：3
AppId	Integer	用户ID 示例值：130****012
ParentIds	String	组织结构示例值：0,236
Total	Integer	设备总数示例值：10
Online	Integer	设备在线数量示例值：7

UpdateRecordBackupPlanData

修改录像上云计划返回数据

被如下接口引用：UpdateRecordBackupPlan。

名称	类型	描述
PlanId	String	录像上云计划ID 示例值：f06d500f-64fb-42c0-b804-********
PlanName	String	录像上云计划名称示例值：录像上云计划1
TemplateId	String	录像上云模板ID 示例值：584fd9d0-569c-4153-aff7-********
Describe	String	录像上云计划描述示例值：这是计划的一部分
LifeCycle	LifeCycleData	云文件生命周期
Status	Integer	录像上云计划状态，1:正常使用中，0:删除中，无法使用示例值： 1
ChannelCount	Integer	通道数量示例值：10
CreateAt	String	创建时间示例值：2023-09-06 15:52:34
UpdateAt	String	修改时间示例值：2023-09-06 15:52:34

UpdateRecordBackupPlanModify

修改录像上云计划数据结构