AddDeviceData

Data returned by the add device API

Used by actions: AddUserDevice.

Name	Type	Description
DeviceId	String	Device iD
Code	String	Device code (for national standard devices, it is the 20-digit National Standard Encoding we generated for the device; for rtmp devices, it is the 10-digit device code)
Name	String	Device name.
AccessProtocol	Integer	Device access protocol. 1: RTMP; 2: GB. Enumeration values: 1: RTMP 2: GB 6: ISUP
Type	Integer	Device type. 1: IPC. 2: NVR
ClusterId	String	Device access service node ID
ClusterName	String	Device access service node name
TransportProtocol	Integer	Device streaming protocol. 1: UDP, 2: TCP
Password	String	Device password.
Description	String	Device description
Status	Integer	Device status. 0: unregistered, 1: online, 2: offline, 3: disabled
OrganizationId	Integer	Affiliated organization ID of the device
GatewayId	String	Device access gateway ID (deprecated, reserved for compatibility, can be ignored)
ProtocolType	Integer	Gateway access protocol type (deprecated, reserved for compatibility, can be ignored)
Ip	String	Device access IP (deprecated, reserved for compatibility, can be ignored)
Port	Integer	Device Port (deprecated, reserved for compatibility, can be ignored)
Username	String	Device username (deprecated, reserved for compatibility, can be ignored)
AppId	Integer	User ID

AddOrgData

Add the return data of the organizational unit interface

Used by actions: AddOrganization.

Name	Type	Description
OrganizationId	String	Organization ID
Name	String	Organization name
ParentId	String	Organization parent node ID
Level	Integer	Organization hierarchy
AppId	Integer	User ID.
ParentIds	String	Organizational structure
Total	Integer	Total number of devices
Online	Integer	Number of devices online

AddRecordBackupPlanData

data for the newly-added recording cloud migration plan

Used by actions: AddRecordBackupPlan.

Name	Type	Description
PlanId	String	Recording cloud migration plan ID
PlanName	String	Recording cloud migration plan name
TemplateId	String	Video cloud template ID
Describe	String	Description of the recording cloud migration plan
LifeCycle	LifeCycleData	Cloud file lifecycle
Status	Integer	Recording cloud migration plan status. 1: in normal use. 0: deleting, unavailable.
ChannelCount	Integer	Number of channels
CreateAt	String	Creation time.
UpdateAt	String	Modification time.

AddRecordBackupTemplateData

data for creating a video cloud template

Used by actions: AddRecordBackupTemplate.

Name	Type	Description
TemplateId	String	Template ID
TemplateName	String	Template name
TimeSections	Array of RecordTemplateTimeSections	Cloud Upload Time Period (set by week, supports setting multiple time periods per day, each time period not less than 10 minutes)
DevTimeSections	Array of RecordTemplateTimeSections	Recording time period (set by week, supports setting multiple time periods per day, each time period not less than 10 minutes)
Scale	Integer	Speed multiplication for cloud migration (supports 1x, 2x, and 4x)
CreateAt	String	Creation time.
UpdateAt	String	Update time.
DayOffset	Integer	Cycle offset. Default value: 1, which means to pull yesterday's video recording from the device. 0 means to pull today's video recording from the device. 3 means to pull the video recording from the device from the day before yesterday. Default value: 1

AddRecordRetrieveTaskData

data for querying retrieval task details

Used by actions: AddRecordRetrieveTask.

Name	Type	Description
TaskId	String	Task ID.
TaskName	String	Task name.
StartTime	Integer	Start time of video recording retrieval
EndTime	Integer	Retrieval end time of the video recording
Mode	Integer	Retrieval mode. 1: ultrafast mode. Others not supported currently.
Expiration	Integer	Replica validity period
Status	Integer	Task status. 0: retrieved, 1: retrieving, 2: pending retrieval
Capacity	Float	Retrieval capacity, in MB.
Describe	String	Task description

AddStreamAuthData

Data structure returned by push/pull stream authentication settings

Used by actions: AddStreamAuth.

Name	Type	Description
Id	String	Authentication configuration ID (uuid).
PullState	Integer	Whether to enable playback authentication. Valid values: 1: enable, 0: disable.
PullSecret	String	Playback key (alphanumeric only, length: 0-10 characters)
PullExpired	Integer	Playback expiration time (unit: minute)
PushState	Integer	Whether to enable stream authentication (1: enable, 0: disable)
PushSecret	String	Stream key (only alphanumeric characters are supported, with a length of 0-10 characters)
PushExpired	Integer	Push expiration time (unit: minute)
AppId	Integer	User ID.

BatchGetVideoSnapshotImageUrlData

Batch obtain the screenshot image URL information list

Used by actions: BatchGetVideoSnapshotImageUrl.

Name	Type	Description
Images	Array of ImageUrlInfo	Image Url information
ImageUrlExpires	Integer	Valid period of the image Url Unit: seconds Default value: 600

BatchOperateDeviceData

Result returned by the batch operation device

Used by actions: BatchOperateDevice.

Name	Type	Description
TaskId	String	Task ID (used to query task progress in the ListSubTasks API for querying the subtask list of a job)

BitRateInfo

Video channel bitrate returned results

Used by actions: DescribeVideoBitRate.

Name	Type	Description
ChannelId	String	Channel Id
Bitrate	Float	Bitrate, in kbps.

CallbackURL

Callback address configuration for screenshots

Used by actions: CreateVLPlan, CreateVideoSnapshotConfig, DescribeVLPlan, DescribeVideoSnapshotConfig, ListVLPlans, ModifyVLPlan, ModifyVideoSnapshotConfig.

Name	Type	Required	Description
Url	String	No	Image callback URL
Token	String	No	Token
Enable	Boolean	No

ChannelAttrInfo

Channel property information

Used by actions: QueryForbidPlayChannelList.

Name	Type	Description
DeviceId	String	Device ID to which the device channel belongs
DeviceName	String	Device name of the device channel
ChannelId	String	Device channel ID
ChannelName	String	Device channel name

ChannelInfo

Channel and device information of the channel

Used by actions: AddRecordBackupPlan, AddRecordPlan, AddRecordRetrieveTask, UpdateRecordBackupPlan, UpdateRecordPlan.

Name	Type	Required	Description
DeviceId	String	Yes	Device ID to which the channel belongs Reference for values ListDevices DescribeDeviceChannel
ChannelId	String	Yes	Device channel ID. A device channel can only be added to one cloud connection plan. Reference for values DescribeDeviceChannel

ControlDeviceStreamData

Returned data of the streaming address.

Used by actions: ControlDeviceStream.

Name	Type	Description
Flv	String	flv stream address.
Hls	String	hls stream address.
Rtmp	String	rtmp stream address.

DescribeDeviceAddrList

Query the list of national standard device addresses

Used by actions: DescribeGBDeviceAddr.

Name	Type	Description
RemoteAddrs	Array of RemoteAddrInfo	List of device addresses

DescribeDeviceChannelData

Returned results of querying device channel information

Used by actions: DescribeDeviceChannel.

Name	Type	Description
DeviceId	String	Device ID
ChannelId	String	Channel ID
ChannelCode	String	Channel encoding
Name	String	Channel name
Status	Integer	Stream status (0: not transmitted, 1: in transit)
PTZType	Integer	Whether Ptz is controllable (0: no, 1: yes)
Manufacturer	String	Channel manufacturer
Resolution	String	Channel supports resolution (resolution list separated by '/', National Standard Protocol example (6/3), custom example (12800960/640480))
State	Integer	Channel offline status (0: offline, 1: online)
Region	String	Region

DescribeDeviceData

Data returned by the device query API

Used by actions: DescribeUserDevice, DescribeUserDeviceList.

Name	Type	Description
DeviceId	String	Device ID
Code	String	Device code (for national standard devices, it is the 20-digit National Standard Encoding we generated for the device; for rtmp devices, it is the 10-digit device code)
Name	String	Device name
AccessProtocol	Integer	Device access protocol. 1: RTMP, 2: GB, 3: GW
Type	Integer	Device type. 1: IPC. 2: NVR.
ClusterId	String	Device access service node id
ClusterName	String	Device access service node name
TransportProtocol	Integer	Device streaming protocol. 1: UDP; 2: TCP
Password	String	Device password
Description	String	Device description
SipId	String	sip service ID
SipDomain	String	sip Service Domain
SipIp	String	sip service IP address
SipPort	Integer	sip server port
PushStreamUrl	String	Rtmp device streaming address (valid only for Rtmp devices)
Status	Integer	Device status. 0: unregistered, 1: online, 2: offline, 3: disabled
OrganizationId	String	Organization ID of the device
GatewayId	String	Device gateway ID, obtained from the query gateway list API (required for gateway access only)
GatewayName	String	Gateway name of the device ownership
ProtocolTypeName	String	Device gateway protocol name
ProtocolType	Integer	Gateway access protocol type. 1. Hikvision SDK, 2. Dahua SDK, 3. Uniview SDK, 4. Onvif (required for gateway access only)
Ip	String	Device connectivity IP
Port	Integer	Device Port
Username	String	Device username
Region	String	Device region
Manufacturer	String	Device vendor
AudioSwitch	Integer	Audio on/off (0: off; 1: on). Audio is dropped when turned off.
SubscribeSwitch	Integer	Subscription switch (0: off; 1: on), enabled by default. When enabled, it subscribes to device channel adjustments. Valid only for national standard NVR devices
AppName	String	Custom appName for RTMP publishing address
StreamName	String	Custom streamName for RTMP publishing address
SilentFrameSwitch	Integer	Whether to enable silent frames (0: disabled; 1: enabled)
PushStreamSecureUrl	String	Rtmp device secure authentication streaming address (valid only for Rtmp devices)

DescribeDeviceListData

Data returned by the batch query device API

Used by actions: DescribeUserDeviceList.

Name	Type	Description
List	Array of DescribeDeviceData	Device detail list

DescribeDevicePresetData

data for querying device preset positions

Used by actions: DescribeDevicePreset.

Name	Type	Description
Index	Integer	Preset position index. Supports only indexes 1-10.
Name	String	Preset position name

DescribeDomainData

Query domain detail data

Used by actions: DescribeDomain.

Name	Type	Description
Id	String	Domain ID
PlayDomain	String	Playback domain
InternalDomain	String	CNAME record value
HaveCert	Integer	Whether to upload a certificate (0: No, 1: Yes)
ClusterId	String	Service node ID
ClusterName	String	Service node name
AppId	Integer	User ID.
CertId	String	Certificate ID
DomainType	Integer	Domain type. 0: Pull streaming domain name; 1: Streaming domain

DescribeDomainRegionData

Query domain name data that can be bound to clusters

Used by actions: DescribeDomainRegion.

Name	Type	Description
Label	String	Service node description
Value	String	Service node ID (the ClusterId required in other APIs)
Region	String	Region information

DescribeOrganizationData

Query the returned result of organizational data

Used by actions: DescribeOrganization.

Name	Type	Description
OrganizationId	String	Organization ID
Name	String	Organization name
ParentId	String	Parent node ID of the organizational unit
Level	Integer	Organizational hierarchy
AppId	Integer	User ID
ParentIds	String	Organizational structure
Total	Integer	Total number of devices
Online	Integer	Number of devices online

DescribeRecordBackupPlanData

data for querying the recording cloud migration plan

Used by actions: DescribeRecordBackupPlan.

Name	Type	Description
PlanId	String	Recording cloud migration plan ID
PlanName	String	Recording cloud migration plan name
TemplateId	String	Video cloud template ID
Describe	String	Description of the recording cloud migration plan
LifeCycle	LifeCycleData	Cloud file lifecycle
Status	Integer	Recording cloud migration plan status. 1: In normal use. 0: Deleting, cannot be used.
ChannelCount	Integer	Number of channels
CreateAt	String	Creation time.
UpdateAt	String	Modification time.

DescribeRecordBackupTemplateData

data for querying video recording cloud templates

Used by actions: DescribeRecordBackupTemplate.

Name	Type	Description
TemplateId	String	Template ID
TemplateName	String	Template name
TimeSections	Array of RecordTemplateTimeSections	Cloud Upload Time Period (settings can be done by week, support setting multiple time periods per day, each time period not less than 10 minutes)
DevTimeSections	Array of RecordTemplateTimeSections	Recording time period (settings can be done by week. You can set multiple time periods each day, each not less than 10 minutes)
Scale	Integer	Speed multiplication for cloud migration (supports 1x, 2x, and 4x)
CreateAt	String	Creation time.
UpdateAt	String	Update time.
DayOffset	Integer	Cycle offset. Default value: 1. It means to pull yesterday's video recording from the device. 0 means to pull today's video recording from the device. 3 means to pull the video recording from the day before yesterday from the device.

DescribeRecordFileData

data used for querying the recording timeline information of the device cloud

Used by actions: DescribeRecordFile.

Name	Type	Description
Tips	Integer	Notification type. 0: No archived video recording within the period. 1: Archived video recording within the period.
List	Array of RecordTimeLine	Exists in array format. If it does not exist, the field content is empty.

DescribeRecordRetrieveTaskData

data for querying the details of a cloud recording retrieval task

Used by actions: DescribeRecordRetrieveTask.

Name	Type	Description
TaskId	String	Retrieval task ID
TaskName	String	Task name for retrieval
StartTime	Integer	Start time of video recording retrieval
EndTime	Integer	Retrieval end time of the video recording
Mode	Integer	Retrieval mode. 1: speed mode. Others not supported currently.
Expiration	Integer	Replica validity period
Status	Integer	Task status. 0: Retrieved, 1: Retrieving, 2: To be retrieved
Capacity	Float	Retrieval capacity, in MB.
Channels	Array of RecordRetrieveTaskChannelInfo	Task device channel id
Describe	String	Task description
ChannelCount	Integer	Number of task channels

DescribeStreamAuthData

Data structure returned by push/pull stream authentication query

Used by actions: DescribeStreamAuth.

Name	Type	Description
Id	String	Authentication configuration ID (uuid).
PullState	Integer	Whether to enable playback authentication. Valid values: 1: enable, 0: disable.
PullSecret	String	Playback key (alphanumeric only, length: 0-10 characters)
PullExpired	Integer	Playback expiration time (unit: minute)
PushState	Integer	Whether to enable stream authentication (1: enable, 0: disable)
PushSecret	String	Stream key (alphanumeric only, length 0-10 characters)
PushExpired	Integer	Push expiration time (unit: minute)
AppId	Integer	User ID.

DescribeVideoBitRateList

Result list returned from querying the bitrate of a video channel

Used by actions: DescribeVideoBitRate.

Name	Type	Description
BitRates	Array of BitRateInfo	List of channel bitrates

DescribeVideoDownloadUrlData

Returned data for obtaining the cloud recording download URL

Used by actions: DescribeVideoDownloadUrl.

Name	Type	Description
Url	String	Video recording file download URL Note: The URL is valid for 10 minutes. Access will be denied after expiry. Obtain a new one if needed. Video file download uses chunked transfer encoding, and the response header is Transfer-Encoding: chunked. The naming format of the downloaded file is {ChannelId}-{BeginTime}-{EndTime}.{FileType}
ActualBeginTime	String	Actual download start time of the video recording Note: This field is returned only when the IsRespActualTime parameter is set to true in the request.
ActualEndTime	String	Actual download end time of the video recording Note: This field is returned only when the IsRespActualTime parameter is set to true in the request.

EffectiveTime

Effective period

Used by actions: CreateVLTemplate, CreateVideoSnapshotTemplate, DescribeVLTemplate, DescribeVideoSnapshotTemplate, ListVLTemplates.

Name	Type	Required	Description
BeginTime	String	Yes	Start time Parameter format: hh:mm:ss
EndTime	String	Yes	End time Parameter format: hh:mm:ss
WeekDay	Integer	Yes	Repetition cycle: 1-Monday 2-Tuesday 3-Wednesday 4-Thursday 5-Friday 6-Saturday 7-Sunday Value range: [1, 7]

GBDeviceSnapInfo

Snapshot information

Used by actions: ListDeviceSnapshots.

Name	Type	Description
FileName	String	File name
DownloadUrl	String	Download link. Empty value means the stored image expires.
ImageSize	Integer	Image size in Unit B.
CreatedTime	String	Creation time of the file.
ReceivedTime	String	Reception time of the image
PreviewUrl	String	Preview link. Empty value means the stored image expires.
SessionId	String	National standard signaling session ID, corresponding to the request_id returned by the ControlDeviceSnapshot API.

ISAPIOutputData

Returned data of the ISUP intelligent secure access API

Used by actions: CallISAPI.

Name	Type	Description
OutputData	String	Output parameter

ImageSceneInfo

Image scenario configuration

Used by actions: CreateVLTemplate, DescribeVLTemplate, ListVLTemplates.

Name	Type	Required	Description
Type	Integer	Yes	Screenshot type Enumeration values: 1: Real-time frame capture 2: Low frequency frame capture
Interval	Integer	Yes	Frame capturing frequency When Type=1, the value range is [5, 180] seconds; when Type=2, the value range is [30, 36000] seconds
MultiMode	MultiSnapshotMode	No	Multiple screenshots mode

ImageUrlInfo

Image download URL information

Used by actions: BatchGetVideoSnapshotImageUrl.

Name	Type	Description
ImageId	String	Image Id
ImageUrl	String	Image Url
ErrorMessage	String	Error information Reason for failure to get the image url

LifeCycleData

Lifecycle, cloud file lifecycle settings, the time when cold and hot storage is managed for files

Used by actions: AddRecordBackupPlan, AddRecordPlan, DescribeRecordBackupPlan, DescribeRecordPlan, ListRecordBackupPlans, ListRecordPlans, UpdateRecordBackupPlan, UpdateRecordPlan.

Name	Type	Required	Description
Transition	Integer	Yes	Hot storage duration of cloud files in days. Minimum value: 1. Maximum value: 3650.
Expiration	Integer	Yes	Cold storage duration of cloud files in days. 0 means leave unset. The minimum is 60 days when set. The sum of the Expiration and Transition fields is no more than 3650 days.

ListDeviceInfo

to the get device list request

Used by actions: ListDevices.

Name	Type	Description
DeviceId	String	Device ID
Code	String	Device code
Status	Integer	Device status. 0: unregistered; 1: online; 2: offline; 3: disabled
TransportProtocol	Integer	Device streaming protocol. 1: UDP, 2: TCP
Name	String	Device name.
Type	Integer	Device type. 1: IPC. 2: NVR
Password	String	Device password
Description	String	Description
ClusterId	String	Node ID of the device access service
ClusterName	String	Service node name
AccessProtocol	Integer	Access protocol. 1: RTMP, 2: GB, 3: GW
OrganizationId	String	Organization ID of the device
ChannelNum	Integer	Number of channels

ListForbidplayChannelsData

data of the channel list where streaming is forbidden for the user

Used by actions: QueryForbidPlayChannelList.

Name	Type	Description
PageNumber	Integer	Which page.
PageSize	Integer	Number of devices on the current page
TotalCount	Integer	Total number of device channels in this query
List	Array of ChannelAttrInfo	Device channel information list

ListOrganizationChannelsData

data of the channel list query under the organizational unit directory

Used by actions: ListOrganizationChannels.

Name	Type	Description
PageNumber	Integer	Which page.
PageSize	Integer	Number of devices on the current page
TotalCount	Integer	Total number of device channels in this query
List	Array of OrganizationChannelInfo	List of device channel information

ListRecordBackupPlanData

data for querying the recording cloud migration plan list

Used by actions: ListRecordBackupPlans.

Name	Type	Description
PlanId	String	Recording cloud migration plan ID
PlanName	String	Recording cloud migration plan name
TemplateId	String	Video cloud template ID
Describe	String	Description of the recording cloud migration plan
LifeCycle	LifeCycleData	Cloud file lifecycle
Status	Integer	Recording cloud migration plan status. 1: in normal use. 0: deleting, unavailable.
ChannelCount	Integer	Number of channels
CreateAt	String	Creation time.
UpdateAt	String	Modification time.

ListRecordBackupPlanDevicesData

data of the query for the associated tunnel of the recording cloud migration plan

Used by actions: ListRecordBackupPlanDevices.

Name	Type	Description
PageNumber	Integer	Which page.
PageSize	Integer	Number of devices on the current page
TotalCount	Integer	Total number of device channels in this query
List	Array of RecordPlanChannelInfo	List of device channel information

ListRecordBackupTemplatesData

List returned for querying cloud templates for video recording

Used by actions: ListRecordBackupTemplates.

Name	Type	Description
TemplateId	String	Template ID
TemplateName	String	Template name
TimeSections	Array of RecordTemplateTimeSections	Cloud Upload Time Period (settings can be done by week, supports setting multiple time periods per day, each time period not less than 10 minutes)
DevTimeSections	Array of RecordTemplateTimeSections	Recording time period (settings can be done by week, supports setting multiple time periods per day, each time period greater than or equal to 10 minutes)
Scale	Integer	Speed multiplication for cloud migration (supports 1x, 2x, and 4x)
CreateAt	String	Creation time.
UpdateAt	String	Update time.
DayOffset	Integer	Cycle offset. Default: 1, which means pulling yesterday's data. 0 means pulling today's data. 3 means pulling the day before yesterday's data.

ListRecordPlanDevicesData

List returned data of device channels under the cloud plan

Used by actions: ListRecordPlanDevices.

Name	Type	Description
PageNumber	Integer	Which page.
PageSize	Integer	Number of devices on the current page
TotalCount	Integer	Total number of device channels in this query
List	Array of RecordPlanChannelInfo	List of device channel information

ListSubTasksData

List the subtask list

Used by actions: ListSubTasks.

Name	Type	Description
List	Array of SubTaskData	Subtask List
TotalCount	Integer	Subtask quantity

ListTasksData

This API is used to query the task list.

Used by actions: ListTasks.

Name	Type	Description
List	Array of TaskData	Task list
TotalCount	Integer	Number of Tasks

ListVideoDownloadTaskData

Local recording download task list

Used by actions: ListVideoDownloadTask.

Name	Type	Description
List	Array of VideoDownloadTask	Task list
TotalCount	Integer	Total number of tasks

ListVideoSnapshotTemplateData

Query the screenshot template detail list

Used by actions: ListVideoSnapshotTemplate.

Name	Type	Description
TotalCount	Integer	Total.
Sort	String	Sorting parameter
Order	String	Sort order
PageNumber	Integer	Page number.
PageSize	Integer	Number of items per page.
List	Array of VideoSnapshotTemplateInfo	Screenshot template list

MultiSnapshotMode

Multiple screenshots mode

Used by actions: CreateVLTemplate, DescribeVLTemplate, ListVLTemplates.

Name	Type	Required	Description
Enable	Boolean	Yes	Whether to enable multiple image mode When set to false, single image mode is used, and the Interval and Total parameters are ignored Default value: false
Interval	Integer	Yes	Frame interception interval Value range: [10, 600] Unit: second
Total	Integer	Yes	Number of captured frames Value range: [1, 10]

MultiVideoSnapshotMode

Parameter of the multiple mode

Used by actions: CreateVideoSnapshotTemplate, DescribeVideoSnapshotTemplate.

Name	Type	Required	Description
Enable	Boolean	Yes	Whether to enable multiple mode. When set to false, single image mode is used, and the Interval and Total parameters are ignored. Default value: false
Interval	Integer	Yes	Frame interception interval Value range: [10, 600] Unit: seconds
Total	Integer	Yes	Number of captured frames Value range: [1, 10]

OrganizationChannelInfo

Channel information under the organization directory

Used by actions: ListOrganizationChannels.

Name	Type	Description
DeviceId	String	Device ID of the device channel
DeviceName	String	Device name of the device channel
ChannelId	String	Device channel ID
ChannelName	String	Device channel name.
InPlan	Boolean	Whether the channel is in a cloud migration plan. If so, it cannot be added to another cloud migration plan | true: in a cloud migration plan, false: not in a cloud migration plan

PlayRecordData

Local recording playback url data structure

Used by actions: PlayRecord.

Name	Type	Description
Flv	String	Video playback address

RecordPlanBaseInfo

Basic information of the real-time cloud migration plan

Used by actions: DescribeRecordPlan, ListRecordPlans.

Name	Type	Description
PlanId	String	Cloud migration plan ID
PlanName	String	Cloud migration plan name
TemplateId	String	Cloud template ID
Describe	String	Cloud migration plan description
StreamType	String	Stream type. default: default stream type of the device. main: main stream. sub: substream. Other stream types can be customized based on the device capacity.
LifeCycle	LifeCycleData	Cloud file lifecycle
Status	Integer	Recording schedule status. 1: In normal use. 0: Deleting, cannot be used.
ChannelCount	Integer	Total number of channels
RepairMode	Integer	Video recording supplement mode (0: not enabled, 1: enabled)

RecordPlanChannelInfo

Channel information of the device under the plan

Used by actions: ListRecordBackupPlanDevices, ListRecordPlanDevices.

Name	Type	Description
DeviceId	String	Device ID to which the device channel belongs
DeviceName	String	Device name of the device channel
ChannelId	String	Device channel ID
ChannelName	String	Device channel name
OrganizationName	String	Affiliated organization name
AccessProtocol	Integer	Access protocol type of the device to which the channel belongs

RecordPlanOptData

data for adding and modifying a real-time cloud migration plan

Used by actions: AddRecordPlan, UpdateRecordPlan.

Name	Type	Description
PlanId	String	Cloud migration plan ID
PlanName	String	Cloud migration plan name
TemplateId	String	Cloud template ID
Describe	String	Cloud migration plan description
LifeCycle	LifeCycleData	Cloud file lifecycle
StreamType	String	Stream type. default: The default stream type of the device. main: Main stream. sub: Substream. Other values are customized based on the device capacity.
RepairMode	Integer	Video recording supplement mode (0: disabled, 1: enabled)

RecordPlaybackUrl

Cloud video playback url

Used by actions: DescribeRecordPlaybackUrl.

Name	Type	Description
Hls	String	hls replay url

RecordRetrieveTaskChannelInfo

Retrieve the task channel information

Used by actions: DescribeRecordRetrieveTask.

Name	Type	Description
DeviceId	String	Device ID to which the device channel belongs
DeviceName	String	Device name of the device channel
ChannelId	String	Device channel ID
ChannelName	String	Device channel name
Status	Integer	Task status. 0: Retrieved, 1: Retrieving, 2: Pending retrieval, 3: No archived video recording

RecordRetrieveTaskDetailsInfo

Basic information of the recording retrieval task

Used by actions: ListRecordRetrieveTasks.

Name	Type	Description
TaskId	String	Task ID.
TaskName	String	Task name.
StartTime	Integer	Start time of video recording retrieval
EndTime	Integer	Retrieval end time of the video recording
Mode	Integer	Retrieval mode. 1: ultrafast mode. Others not supported currently.
Expiration	Integer	Replica validity period
Status	Integer	Task status. 0: Retrieved, 1: Retrieving, 2: Pending retrieval
Capacity	Integer	Retrieval capacity, in MB.
Describe	String	Task description
ChannelCount	Integer	Number of task channels

RecordTemplateInfo

Real-time cloud template information data

Used by actions: AddRecordTemplate, DescribeRecordTemplate, ListRecordTemplates, UpdateRecordTemplate.

Name	Type	Description
TemplateId	String	Template ID.
TemplateName	String	Template name
TimeSections	Array of RecordTemplateTimeSections	Cloud upload time period. Settings can be done by week. Multiple time periods can be set for each day, with each time period greater than or equal to 10 minutes.

RecordTemplateTimeSections

Data format of the time segment in the cloud template

Used by actions: AddRecordBackupTemplate, AddRecordTemplate, DescribeRecordBackupTemplate, DescribeRecordTemplate, ListRecordBackupTemplates, ListRecordTemplates, UpdateRecordBackupTemplate, UpdateRecordTemplate.

Name	Type	Required	Description
DayOfWeek	Integer	Yes	Day of the week. Value range: 1–7 (corresponding to Monday–Sunday)
StartTime	String	Yes	Start time. Format: HH:MM:SS. Range: [00:00:00–23:59:59]
EndTime	String	Yes	End time. Format: HH:MM:SS. Range: [00:00:00–23:59:59]

RecordTimeLine

Cloud Recording time segment

Used by actions: DescribeRecordFile.

Name	Type	Description
Begin	Integer	Segment start time in UTC seconds, for example: 1662114146
End	Integer	Segment end time in UTC seconds, for example: 1662114146
HlsUrl	String	Playback url of the corresponding recording clip

RemoteAddrInfo

Device address return result

Used by actions: DescribeGBDeviceAddr.

Name	Type	Description
DeviceId	String	Device Id
Addr	String	IP address

SetForbidplayChannelParam

Set the channel to forbid stream publishing. It has the Channel Id and enable fields.

Used by actions: SetForbidPlayChannels.

Name	Type	Required	Description
ChannelId	String	Yes	Channel Id
Enable	Boolean	Yes	Whether to forbid stream pushing over the channel

SubTaskData

Subtask details

Used by actions: ListSubTasks.

Name	Type	Description
SubTaskId	String	Subtask ID
Status	Integer	Task status. 1: NEW, 2: RUNNING, 3: COMPLETED, 4: FAILED
FailReason	String	Cause of the task failure.
Progress	Float	Task progress
Action	String	Operation type.
ActionZhDesc	String	Operation type Chinese description
ResourceId	String	Resource ID
StartedAt	String	Task start time
CreatedAt	String	Task creation time
UpdatedAt	String	Task update time
Runtime	Integer	Task running time in milliseconds
DeviceId	String	Device ID
DeviceName	String	Device name.
ChannelId	String	Channel ID
ChannelName	String	Channel name

TaskData

Returned results of querying complex task details

Used by actions: DescribeTask, ListTasks.

Name	Type	Description
TaskId	String	Task ID.
Status	Integer	Task status. 1: NEW, 2: RUNNING, 3: COMPLETED, 4: FAILED
FailReason	String	Reason for failure
Progress	Float	Progress (0-1)
Action	String	Task operation type. A batch task type starts with "Batch".
ActionZhDesc	String	Operation type Chinese description
TaskType	Integer	Task type. 1. Simple 2. Complex 3. Subtask
ResourceId	String	Task resource ID (invalid for complex tasks)
Total	Integer	Total number of tasks (valid only for complex tasks)
SuccessCount	Integer	Successful Tasks (valid only for complex tasks)
FailCount	Integer	Number of failed tasks (valid only for complex tasks)
RunningCount	Integer	Number of running tasks (valid only for complex tasks)
StartedAt	String	Task start time.
CreatedAt	String	Task creation time
UpdatedAt	String	Update task time.
Runtime	Integer	Task running time in milliseconds.
DeviceId	String	Device ID
DeviceName	String	Device name.
ChannelId	String	Channel ID
ChannelName	String	Channel name

Timeline

Time segment structure

Used by actions: ControlRecordTimeline.

Name	Type	Description
Begin	Integer	Fragment start time
End	Integer	Shard end time

UpdateDeviceData

Modify the device interface return data

Used by actions: UpdateUserDevice.

Name	Type	Description
DeviceId	String	Device ID
Code	String	Device code (for national standard devices, it is the 20-digit National Standard Encoding we generated for the device; for rtmp devices, it is the 10-digit device code)
Name	String	Device name.
AccessProtocol	Integer	Device access protocol. 1: RTMP; 2: GB. Enumeration values: 1: RTMP 2: GB
Type	Integer	Device type. 1: IPC. 2: NVR
ClusterId	String	Device access service node ID
ClusterName	String	Device access service node name
TransportProtocol	Integer	Device streaming protocol. 1: UDP, 2: TCP
Password	String	Device password.
Description	String	Device description
Status	Integer	Device status. 0: unregistered, 1: online, 2: offline, 3: disabled
OrganizationId	Integer	Affiliated organization ID of the device
GatewayId	String	Device access gateway ID (deprecated, reserved for compatibility, can be ignored)
ProtocolType	Integer	Gateway access protocol type (deprecated, reserved for compatibility, can be ignored)
Ip	String	Device access IP
Port	Integer	Device Port
Username	String	Device username
AppId	Integer	User Id

UpdateOrgData

Modify the interface return data of an organizational unit

Used by actions: UpdateOrganization.

Name	Type	Description
OrganizationId	String	Organization ID
Name	String	Organization name
ParentId	String	Organizational parent node ID
Level	Integer	Organization hierarchy
AppId	Integer	User ID.
ParentIds	String	Organizational structure
Total	Integer	Total number of devices
Online	Integer	Number of devices online

UpdateRecordBackupPlanData

data for modifying the recording cloud migration plan

Used by actions: UpdateRecordBackupPlan.

Name	Type	Description
PlanId	String	Recording cloud migration plan ID
PlanName	String	Recording cloud migration plan name
TemplateId	String	Video cloud template ID
Describe	String	Description of the recording cloud migration plan
LifeCycle	LifeCycleData	Cloud file lifecycle
Status	Integer	Recording cloud migration plan status. 1: in normal use. 0: deleting, unavailable.
ChannelCount	Integer	Number of channels
CreateAt	String	Creation time.
UpdateAt	String	Modification time.

UpdateRecordBackupPlanModify

Modify the data structure of the recording cloud migration plan

Used by actions: UpdateRecordBackupPlan.

Name	Type	Required	Description
PlanName	String	No	Recording cloud migration plan name (supports only Chinese, English, digits, _, and -, length not exceeding 32 characters. The plan name must be globally unique and cannot be empty or repeated. This field is not required if the name is not modified.)
TemplateId	String	No	Recording template ID (obtain from the ListRecordBackupTemplates API for querying the video recording upload template list. This field is not required if the template ID is not modified) Reference for values ListRecordTemplates
Describe	String	No	Recording cloud migration plan description (only supports Chinese, English, numbers, _, -, length not exceeding 128 characters. This field is not required if the description is not modified)
LifeCycle	LifeCycleData	No	Lifecycle (lifecycle settings for video recording files, managing the time when files are in cold or hot storage. This field is not required if you do not modify the lifecycle)
Add	Array of ChannelInfo	No	Device channels to be added (Json array; not required when no channels are added; the total number of channels added at once cannot exceed 5000, including the number of channels under the organizational directory)
Del	Array of String	No	Device channel to delete (Json array containing the IDs of device channels to delete. Not required if no device channel is deleted) Reference for values ListDevices
OrganizationId	Array of String	No	Add the channels of all devices under the organizational unit (Json array, can be empty, and the total number of channels no more than 5000, including the number of channels in the Add field) Reference for values DescribeOrganization

UpdateRecordBackupTemplateData

data for modifying a video cloud template

Used by actions: UpdateRecordBackupTemplate.

Name	Type	Description
TemplateId	String	Template ID
TemplateName	String	Template name
TimeSections	Array of RecordTemplateTimeSections	Cloud Upload Time Period (set by week, supports setting multiple time periods per day, each time period not less than 10 minutes)
DevTimeSections	Array of RecordTemplateTimeSections	Recording time period (set by week, supports setting multiple time periods per day, each time period not less than 10 minutes)
Scale	Integer	Speed multiplication for cloud migration (supports 1x, 2x, and 4x)
CreateAt	String	Creation time.
UpdateAt	String	Update time.
DayOffset	Integer	Cycle offset. Default value: 1, which means to pull yesterday's video recording from the device. 0 means to pull today's video recording from the device. 3 means to pull the video recording from the device from the day before yesterday.

UpdateRecordBackupTemplateModify

Modify the video cloud template data structure

Used by actions: UpdateRecordBackupTemplate.

Name	Type	Required	Description
TemplateName	String	No	Template name (not required if you do not rename)
TimeSections	Array of RecordTemplateTimeSections	No	Cloud upload time period (settings can be done by week. Multiple time periods can be set for each day, with each time period not less than 10 minutes)
DevTimeSections	Array of RecordTemplateTimeSections	No	Recording time period (set by week. Multiple time periods can be set each day, each not less than 10 minutes)
Scale	Integer	No	Cloud speed multiplication (supports 1x, 2x, and 4x).

UpdateRecordPlanData

Modify the data of the real-time Cloud Recording plan

Used by actions: UpdateRecordPlan.

Name	Type	Required	Description
PlanName	String	No	Cloud migration plan name, supporting only Chinese, English, digits, _, -, with a length not exceeding 32 characters. The plan name must be globally unique and cannot be empty or duplicated. This field is not required if the name is not modified.
TemplateId	String	No	Cloud template ID. This field is not required if the template ID is not modified.
Describe	String	No	Usage plan description. It can contain only Chinese characters, English letters, digits, underscores (_), and hyphens (-), with a length not exceeding 128 characters. This field is not required if you do not modify the description.
StreamType	String	No	Stream type. default: The stream type is not specified, and the default push type of the device is used. main: main stream. sub: substream. Other: custom based on the device capability set. The length cannot exceed 32 bytes.
LifeCycle	LifeCycleData	No	Lifecycle, file lifecycle settings, the time when cold and hot storage of files is managed. This field is not required if lifecycle is not modified.
Add	Array of ChannelInfo	No	Device channels to be added. Json array. This field is not required when no channels are added. The total number of channels added at once cannot exceed 5,000, including the number of channels under the organization directory.
Del	Array of String	No	Device channels to delete. Json array. The content is the IDs of the device channels to delete. This field is not required if no device channel is deleted.
OrganizationId	Array of String	No	Organizational directory ID. Add all device channels under the organizational directory. Json array. Can be empty. And the total number of channels is no more than 5,000 (including the number of channels added in the Add field).
RepairMode	Integer	No	Video recording supplement mode (0: not enabled, 1: enabled)

UpdateRecordTemplateData

Request data structure for modifying a real-time cloud template

Used by actions: UpdateRecordTemplate.

Name	Type	Required	Description
TemplateName	String	No	Template name. If you do not modify the name, you do not need to include this field.
TimeSections	Array of RecordTemplateTimeSections	No	Cloud upload time period. If you do not modify the name, you do not need to include this field.

VLPlanInfo

Visual understanding plan information

Used by actions: CreateVLPlan, DescribeVLPlan, ListVLPlans, ModifyVLPlan.

Name	Type	Description
VLPlanId	String	Plan ID
Name	String	Plan name.
Describe	String	Plan description.
VLTemplateId	String	ID of the visual understanding template
Callback	CallbackURL	Callback notification configuration
FileExpires	Integer	File expiration time (seconds)
ChannelCount	Integer	Number of channels included in the plan
CreatedAt	String	Creation time.
UpdatedAt	String	Last update time

VLPlanResultDetailInfo

Visual understanding plan result details

Used by actions: DescribeVLPlanResult.

Name	Type	Description
VLPlanResultId	String	Analysis result ID
MediaType	String	Media type. The current fixed value is image
VLPlanId	String	ID of the associated analysis plan
VLPlanName	String	Plan name
ChannelId	String	Channel ID
ChannelName	String	Channel name
DeviceId	String	Device ID
DeviceName	String	Device name
OrganizationId	String	Affiliated organization ID
OrganizationName	String	Affiliated organization name
VLResultTimestamp	Integer	Analysis timestamp (seconds)
SnapshotTimestamp	Integer	Image mode screenshot timestamp (seconds)
VideoStartTimestamp	Integer	Video clip start timestamp (seconds)
VideoEndTimestamp	Integer	Video segment end timestamp (seconds)
BilledFrameCount	Integer	Billing method for the number of frames in video mode
Content	String	AI analysis result content (JSON string)
ImageUrl	String	Temporary screenshot download URL (valid for 300 seconds)
ImageUrlExpire	Integer	Screenshot URL validity period (seconds)
CreatedAt	String	Creation time, format: 2006-01-02 15:04:05
UpdatedAt	String	Update time, format 2006-01-02 15:04:05

VLPlanResultSnapshotImageUrlInfo

Visual understanding plan source material URL information

Used by actions: BatchGetVLPlanSourceFileURL.

Name	Type	Description
VLPlanResultId	String	Analysis result ID
SourceFileURL	String	Source material download URL (empty if unsuccessful)
Expire	Integer	URL validity period (seconds; 0 on failure)
ErrMsg	String	Error information (has a value on failure)

VLTemplateInfo

Visual understanding template information

Used by actions: CreateVLTemplate, DescribeVLTemplate, ListVLTemplates.

Name	Type	Description
VLTemplateId	String	Template ID
AIModel	String	AI model Enumeration values: IVC-G: Default large model for view
Name	String	AI scenario name
Describe	String	AI scenario description
Prompt	String	Prompt content
AnalysisMode	String	Analysis mode Enumeration values: image: Image mode video: Video mode
ImageConfig	ImageSceneInfo	Image scenario configuration
Times	Array of EffectiveTime	Effective period list
CreatedAt	String	Creation time.
UpdatedAt	String	Last update time
IsUsed	Boolean	Whether associated with a visual understanding plan
VideoConfig	VideoSceneInfo	Video scene configuration

VideoDownloadTask

Local recording download task

Used by actions: ListVideoDownloadTask.

Name	Type	Description
DownloadTaskId	String	Download task ID
ChannelId	String	Channel ID
ChannelName	String	Channel name
ChannelCode	String	Channel encoding
DeviceName	String	Device name.
DeviceCode	String	Device code
Status	Integer	Task status (0: pending; 1: executing; 2: task complete; 3: Task failure)
VideoTimeSection	String	Download the recording time period
Scale	Integer	Playback speed
DownloadTime	Integer	Download duration.
VideoSize	Integer	Video recording size
StartTime	String	Task start time
EndTime	String	Task end time
FileDownloadUrl	String	File download address
FailedReason	String	Reason for failure
Expire	Integer	Lifecycle rule, number of days in hot storage
PreviewUrl	String	mp4 preview address

VideoDownloadTaskData

Recording download task data structure

Used by actions: CreateVideoDownloadTask.

Name	Type	Description
DownloadTaskId	String	Download task ID

VideoSceneInfo

Video scene configuration (reservation)

Used by actions: CreateVLTemplate, DescribeVLTemplate, ListVLTemplates.

Name	Type	Required	Description
Interval	Integer	Yes	Analysis interval (seconds): trigger an analysis every few seconds (sliding step length)
Duration	Integer	Yes	Analysis segment duration (seconds): length of the video window fed into the model at a time, range [5, 12800]
Fps	Float	No	Frame sampling rate. Default value: 1. Value range: [0.1, 1]. One frame is sampled every 1/Fps seconds and sent to the model.

VideoSnapshotConfigInfo

Screenshot configuration message

Used by actions: CreateVideoSnapshotConfig, DescribeVideoSnapshotConfig, ModifyVideoSnapshotConfig.

Name	Type	Description
ConfigId	String	Screenshot configuration Id
TemplateId	String	Screenshot template Id
Name	String	Screenshot configuration name
Type	Integer	Screenshot type Enumeration values: 1: Real-time frame capture 2: Low frequency frame capture
FileExpires	Integer	Image storage days Unit: days
Callback	CallbackURL	Callback configuration
CreateTime	String	Creation time.
UpdateTime	String	Last update time

VideoSnapshotTemplateInfo

Screenshot template information

Used by actions: CreateVideoSnapshotTemplate, DescribeVideoSnapshotTemplate, ListVideoSnapshotTemplate.

Name	Type	Description
TemplateId	String	Screenshot template Id
Name	String	Screenshot template name
Type	Integer	Screenshot type Enumeration values: 1: Real-time frame capture 2: Low frequency frame capture
Interval	Integer	Frame capturing frequency
MultiMode	MultiVideoSnapshotMode	Multiple mode
Times	Array of EffectiveTime	Effective period
RelatedConfigCount	Integer	Number of configurations associated with the template
CreateTime	String	Creation time.
UpdateTime	String	Last update time