接口描述
默认接口请求频率限制：500次/秒。
查询设备通道列表。
接口约束
确保查询的该设备已存在，未删除状态
URL
GET /v1?
请求参数
| 参数 |
类型 |
是否必选 |
示例值 |
描述 |
| Action |
String |
是 |
DescribeDeviceChannels |
操作接口名，系统规定参数。 |
| InProtocol |
String |
是 |
gb28181 |
使用的接入协议。取值: gb28181 |
| DeviceId |
String |
是 |
32388487739092996 |
设备ID。 |
返回参数
| 参数 |
类型 |
描述 |
| DeviceId |
String |
设备ID。 |
| GroupId |
String |
设备所属组ID。 |
| GbId |
String |
设备国标ID。 |
| DeviceEnabled |
Long |
设备是否启用。取值：0(停用), 1(启用) |
| DeviceStatus |
String |
设备状态。取值：on(在线), off(离线), new(未注册)。 |
| CreateSubDevice |
Long |
是否自动创建子设备。取值：1(自动创建), 2(手动创建) |
| DeviceStats |
DeviceStats |
设备统计信息。 |
| DeviceChannels |
DeviceChannel[] |
nvr设备通道列表。ipc设备忽略该字段，nvr设备才返回。 |
| CreatedTime |
String |
设备创建时间。 |
| UpdatedTime |
String |
设备更新时间。 |
| RequestId |
String |
唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
DeviceStats
| 参数 |
类型 |
描述 |
| ChannelSize |
Long |
通道数量。 |
| OnlineChannels |
Long |
在线通道数量。 |
| OfflineChannels |
Long |
离线通道数量。 |
| OnlineStreams |
Long |
在线流数量。 |
| OfflineStreams |
Long |
离线流数量。 |
| FailedStreams |
Long |
失败流数量。 |
| MaxChannelSize |
Long |
最大通道数量。 |
DeviceChannel
| 参数 |
类型 |
描述 |
| ChannelNum |
Long |
通道号。 |
| ChannelName |
String |
通道名称。 |
| GbId |
String |
设备国标ID。 |
| DeviceId |
String |
设备ID。 |
| DeviceStatus |
String |
设备状态。取值：on(在线), off(离线), new(未注册)。 |
| StreamStatus |
String |
流状态。取值：on(在线), off(离线), failed(失败)。 |
| CreatedTime |
String |
子设备（通道）创建时间。 |
| UpdatedTime |
String |
子设备（通道）更新时间。 |
| RecordStatus |
Long |
录制状态。 |
| RecordTaskId |
String |
录制任务ID。 |
| InType |
String |
视频流接入方式。 |
| MultiStreamSize |
Long |
主子码流数量。 |
| AutoStreamNum |
Long |
自动拉取第几个码流。 |
| ParentDeviceId |
String |
父设备id。 |
| CreateSubDevice |
Long |
是否自动创建子设备。 |
| DeviceVendor |
String |
设备厂商。 |
| DeviceStreams |
DeviceStream[] |
设备视频流信息。 |
| RecordMessage |
String |
录制信息。 |
DeviceStream
| 参数 |
类型 |
描述 |
| StreamNum |
Long |
视频流编号。 |
| StreamStatus |
String |
视频流状态。 |
示例
请求示例
GET https://vss-dsp-gzgy2-a.ctapi.ctyun.cn/v1?Action=DescribeDeviceChannels&DeviceId=581837913938542592&InProtocol=gb28181
Connection: keep-alive
ctyun-eop-request-id: e362d91a-7695-4230-a0b2-333760985585
Eop-date: 20221025T100103Z
Eop-Authorization: BLLOJSUVKOZ7RVV9VEFF Headers=ctyun-eop-request-id;eop-date Signature=BGJeDe7lBNcOMMV/Y9o+2wLUkxYs7ChbRbJWvFsEQ1w=
Host: vss-dsp-gzgy1-a.ctapi-test.ctyun.cn
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.14)
返回示例
{
"DeviceId": "581837913938542592",
"GroupId": "581837888168738816",
"GbId": "51030300101187001971",
"DeviceEnabled": 1,
"DeviceStatus": "new",
"CreateSubDevice": 1,
"DeviceStats": {
"ChannelSize": 2,
"OnlineChannels": 0,
"OfflineChannels": 0,
"OnlineStreams": 0,
"OfflineStreams": 0,
"FailedStreams": 0,
"MaxChannelSize": 0
},
"DeviceChannels": [
{
"ChannelNum": 1,
"ChannelName": "通道1",
"GbId": "51030300101327017425",
"DeviceId": "581837913938542593",
"DeviceStatus": "new",
"StreamStatus": "",
"CreatedTime": "2022-10-25 10:01:03",
"UpdatedTime": "2022-10-25 10:01:03",
"RecordStatus": 0,
"RecordTaskId": "",
"MultiStreamSize": 0,
"AutoStreamNum": 0,
"ParentDeviceId": "",
"DeviceVendor": "",
"Deleted": "",
"TransPriority": "",
"InType": "",
"DeviceStreams": [
],
"CreateSubDevice": 0,
"OrderSequence": "0",
"RecordMessage": "",
"errorCode": "",
"errorMessage": "",
"bitrate": 0,
"PoleId": "",
"SerialNumber": "",
"DeviceModel": ""
},
{
"ChannelNum": 2,
"ChannelName": "通道2",
"GbId": "51030300101327017426",
"DeviceId": "581837913938542594",
"DeviceStatus": "new",
"StreamStatus": "",
"CreatedTime": "2022-10-25 10:01:03",
"UpdatedTime": "2022-10-25 10:01:03",
"RecordStatus": 0,
"RecordTaskId": "",
"MultiStreamSize": 0,
"AutoStreamNum": 0,
"ParentDeviceId": "",
"DeviceVendor": "",
"Deleted": "",
"TransPriority": "",
"InType": "",
"DeviceStreams": [
],
"CreateSubDevice": 0,
"OrderSequence": "0",
"RecordMessage": "",
"errorCode": "",
"errorMessage": "",
"bitrate": 0,
"PoleId": "",
"SerialNumber": "",
"DeviceModel": ""
}
],
"CreatedTime": "2022-10-25 10:01:03",
"UpdatedTime": "2022-10-25 10:01:03",
"RequestId": "939afe6bdd2a4193966e1e16052a8e79",
"OrderSequence": "-1666663263184"
}
错误码
错误码
