接口描述

默认接口请求频率限制：500次/秒。

查询设备列表。

接口约束

查询的GroupId确保已存在，未删除。

URL

GET /v1?

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	DescribeDevices	操作接口名，系统规定参数。
InProtocol	String	是	gb28181	使用的接入协议。取值: gb28181
GroupId	String	是	32388487739092994	根据设备所属组ID查询。
DirId	String	否	897098424844288	根据设备所属目录ID查询。
DeviceType	String	否	ipc	根据设备类型查询。取值: ipc,nvr
DeviceStatus	String	否	on	根据设备状态查询。取值：on(在线), off(离线), new(未注册)。
StreamStatus	String	否	on	根据流状态查询。取值：on(在线), off(离线), failed(失败)。
SortBy	String	否	CreatedTime	选择按一个字段排序，可选值为：DeviceID、CreatedTime、UpdatedTime，默认为CreatedTime，按照创建时间排序。
SortDirection	String	否	asc	排序方式，默认升序。取值：asc(升序), desc(降序)。
PageNum	Long	否	1	第几个分页，默认为1。
PageSize	Long	否	20	分页大小，默认为10。取值范围为1～1000
IncludeDeviceStats	Long	否	0	是否返回设备统计信息，默认0。取值：0(不返回), 1(返回)
IncludeDeviceDir	Long	否	0	是否返回目录信息，默认0。取值：0(不返回), 1(返回)

返回参数

参数	类型	描述
PageNum	Long	第几个分页。
PageSize	Long	分页大小。
TotalPage	Long	分页总数。
TotalNum	Long	设备总数。
Devices	Device[]	设备列表。
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
DirStats	DirStats	目录统计信息。
Actions	String[]	操作集合。

Device

参数	类型	描述
DeviceId	String	设备ID。
GroupId	String	设备所属组ID。
ParentDeviceId	String	上级设备ID，比如摄像头所属的NVR设备ID。
DirId	String	设备所属目录ID。
DeviceType	String	设备类型。取值: ipc,nvr
GbVersion	String	国标版本。取值: 2011, 2016
DeviceVendor	String	设备厂商。
DeviceName	String	设备名称。
Description	String	设备描述。
DeviceIp	String	设备IP。
DevicePort	Long	设备Port。
InProtocol	String	设备使用的接入协议。取值: gb28181
UserName	String	设备用户名，在创建GB28181凭证时生成。
GbId	String	设备国标ID。
PullType	Long	是否启用自动拉流。仅gb28181组支持该字段。取值：1, 2取值为1，自动拉流，国标设备注册成功后自动启动拉流；取值为2，按需拉流，需要通过触发的方式启动拉流。
TransPriority	String	设备视频流优先传输协议，默认tcp。取值：tcp, udp。取值为tcp，如果设备支持tcp协议传输，设备进行视频邀约时优先使用tcp协议接入到vss服务中。取值为udp，设备进行视频邀约时优先使用udp协议接入到vss服务中。
DeviceEnabled	Long	设备是否启用。取值：0(停用), 1(启用)
DeviceStatus	String	设备状态。取值：on(在线), off(离线), new(未注册)。
StreamStatus	String	流状态。取值：on(在线), off(离线), failed(失败)。
SipTransType	String	信令传输类型。取值：tcp, udp
StreamTransType	String	流传输类型。ps_rtp_udp: PS over RTP UDPps_rtp_tcp: PS over RTP TCPh264_rtp_udp: H264 over RTP UDPh264_rtp_tcp: H264 over RTP TCP
CreateSubDevice	Long	是否自动创建子设备。取值：1(自动创建), 2(手动创建)
DeviceStats	DeviceStats	设备统计信息。
DeviceDir	DeviceDir	设备目录。
SerialNumber	String	设备SN码。
DeviceModel	String	设备型号。
CreatedTime	String	设备创建时间。
UpdatedTime	String	设备更新时间。
RecordStatus	Long	录制状态。
RecordTaskId	String	录制任务ID。
GbRegion	String	设备区域编码。
GbRegionLevel	String	设备区域级别。
PushType	Long	是否启用自动激活推流地址。
InType	String	视频流接入方式。
PushUrl	String	推流地址。
PullUrl	String	拉流地址。
Tags	String	标签。
MultiStreamSize	Long	主子码流数量。
AutoStreamNum	Long	自动拉取第几个码流。
DeviceSn	String	设备ID序列号。
DeviceFirmware	String	设备固件号。
DeviceHardware	String	设备硬件号。
DevicePosition	String	设备位置。
DevicePubIp	String	设备公网出口Ip。
DevicePubPort	Long	设备公网出口Port。
EhomeVersion	String	ehome版本。
ChannelSize	Long	通道数量。
ChannelNum	Long	通道号。
ChannelName	String	通道名称。
DeviceStreams	DeviceStream[]	设备视频流信息。
DeviceLongitude	String	设备经度。
DeviceLatitude	String	设备纬度。
DeviceDomain	String	设备域名。
EnableDomain	Long	是否启用域名。

DeviceStats

参数	类型	描述
ChannelSize	Long	通道数量。
OnlineChannels	Long	在线通道数量。
OfflineChannels	Long	离线通道数量。
OnlineStreams	Long	在线流数量。
OfflineStreams	Long	离线流数量。
FailedStreams	Long	失败流数量。
MaxChannelSize	Long	最大通道数量。

DeviceDir

参数	类型	描述
DirId	String	目录ID。
DirName	String	目录名称。
Description	String	目录描述。
GroupId	String	目录所属组ID。
ParentDirId	String	上级目录ID。
CreatedTime	String	目录创建时间。
UpdatedTime	String	目录修改时间。

DeviceStream

参数	类型	描述
StreamNum	Long	视频流编号。
StreamStatus	String	视频流状态。

DirStats

参数	类型	描述
DeviceSize	String	设备数量
IpcSize	String	IPC设备数量
NvrSize	String	NVR设备数量
PlatformSize	String	平台设备数量

示例

请求示例

GET https://vss-dsp-gzgy2-a.ctapi.ctyun.cn/v1?Action=DescribeDevices&DeviceStatus=new&DirId=581834160137125889&GroupId=581834160137125888&InProtocol=gb28181&IncludeDeviceDir=1&IncludeDeviceStats=1&PageNum=1&PageSize=20&SortBy=CreatedTime&SortDirection=asc
Connection: keep-alive
ctyun-eop-request-id: f8604cda-b7c9-41e4-bbc5-d08ac11971c8
Eop-date: 20221025T095349Z
Eop-Authorization: BLLOJSUVKOZ7RVV9VEFF Headers=ctyun-eop-request-id;eop-date Signature=iTHr9rAZMPYkUq3hyj3toofecuYWLThHPdZUCZiJrjk=
Host: vss-dsp-gzgy1-a.ctapi-test.ctyun.cn
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.14)

返回示例

{
    "PageNum": 1,
    "PageSize": 20,
    "TotalPage": 1,
    "TotalNum": 2,
    "Devices": [
        {
            "DeviceId": "582033635598254083",
            "GroupId": "582033635598254080",
            "ParentDeviceId": "-1",
            "DirId": "582033635598254081",
            "DeviceType": "ipc",
            "DeviceVendor": "海康",
            "DeviceName": "createvf",
            "Description": "xxx路口摄像头",
            "DeviceIp": "",
            "DevicePort": 0,
            "InProtocol": "gb28181",
            "UserName": "create2r45bp",
            "UserPassword": "Cert1234",
            "GbId": "51030300101327017545",
            "PullType": 1,
            "TransPriority": "tcp",
            "DeviceEnabled": 1,
            "DeviceStatus": "new",
            "StreamStatus": "",
            "SipTransType": "",
            "StreamTransType": "",
            "CreateSubDevice": -1,
            "GbVersion": "2016",
            "DeviceStats": null,
            "DeviceDir": {
                "DirId": "582033635598254081",
                "DirName": "nbg",
                "Description": "目录描述",
                "GroupId": "582033635598254080",
                "ParentDirId": "0",
                "CreatedTime": "2022-10-25 16:20:48",
                "UpdatedTime": "2022-10-25 16:20:48"
            },
            "CreatedTime": "2022-10-25 16:20:48",
            "UpdatedTime": "2022-10-25 16:20:48",
            "RecordStatus": 0,
            "RecordTaskId": "",
            "InType": "",
            "PushType": 0,
            "DeviceModel": "",
            "DeviceSn": "",
            "DeviceFirmware": "",
            "DeviceHardware": "",
            "DevicePosition": "",
            "DevicePubIp": "",
            "DevicePubPort": 0,
            "EhomeVersion": "",
            "ChannelSize": 0,
            "ChannelNum": 0,
            "ChannelName": "",
            "autoStreamNum": 0,
            "DeviceChannels": [
  
            ],
            "DeviceStreams": [
  
            ],
            "MultiStreamSize": 0,
            "DeviceLongitude": "0",
            "DeviceLatitude": "0",
            "GbRegion": "51030300",
            "GbRegionLevel": 3,
            "DeviceDomain": "",
            "EnableDomain": 0,
            "OrderSequence": "-1666686048829",
            "IndustryCode": "10",
            "NetworkCode": "7",
            "RecordMessage": "",
            "errorCode": "",
            "errorMessage": "",
            "bitrate": 0,
            "MacAddr": "",
            "PoleId": "",
            "SerialNumber": ""
        },
        {
            "DeviceId": "582033644188188672",
            "GroupId": "582033635598254080",
            "ParentDeviceId": "-1",
            "DirId": "582033635598254081",
            "DeviceType": "nvr",
            "DeviceVendor": "大华",
            "DeviceName": "createfd",
            "Description": "xxx路口摄像头",
            "DeviceIp": "192.168.0.1",
            "DevicePort": 8080,
            "InProtocol": "gb28181",
            "UserName": "create2r45bp",
            "UserPassword": "Cert1234",
            "GbId": "51030300101187002049",
            "PullType": 1,
            "TransPriority": "tcp",
            "DeviceEnabled": 1,
            "DeviceStatus": "new",
            "StreamStatus": "",
            "SipTransType": "",
            "StreamTransType": "",
            "CreateSubDevice": 1,
            "GbVersion": "2016",
            "DeviceStats": {
                "ChannelSize": 3,
                "OnlineChannels": 0,
                "OfflineChannels": 0,
                "OnlineStreams": 0,
                "OfflineStreams": 0,
                "FailedStreams": 0,
                "MaxChannelSize": 3
            },
            "DeviceDir": {
                "DirId": "582033635598254081",
                "DirName": "nbg",
                "Description": "目录描述",
                "GroupId": "582033635598254080",
                "ParentDirId": "0",
                "CreatedTime": "2022-10-25 16:20:48",
                "UpdatedTime": "2022-10-25 16:20:48"
            },
            "CreatedTime": "2022-10-25 16:20:49",
            "UpdatedTime": "2022-10-25 16:20:49",
            "RecordStatus": 0,
            "RecordTaskId": "",
            "InType": "",
            "PushType": 0,
            "DeviceModel": "",
            "DeviceSn": "",
            "DeviceFirmware": "",
            "DeviceHardware": "",
            "DevicePosition": "",
            "DevicePubIp": "",
            "DevicePubPort": 0,
            "EhomeVersion": "",
            "ChannelSize": 0,
            "ChannelNum": 0,
            "ChannelName": "",
            "autoStreamNum": 0,
            "DeviceChannels": [
  
            ],
            "DeviceStreams": [
  
            ],
            "MultiStreamSize": 0,
            "DeviceLongitude": "0",
            "DeviceLatitude": "0",
            "GbRegion": "51030300",
            "GbRegionLevel": 3,
            "DeviceDomain": "",
            "EnableDomain": 0,
            "OrderSequence": "-1666686049828",
            "IndustryCode": "10",
            "NetworkCode": "7",
            "RecordMessage": "",
            "errorCode": "",
            "errorMessage": "",
            "bitrate": 0,
            "MacAddr": "",
            "PoleId": "",
            "SerialNumber": ""
        }
    ],
    "RequestId": "fdd12cd43fb54c49a4164edd61139e01",
    "actions": [
  
    ]
}

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

智能视图服务

智能视图服务

接口描述

接口约束

URL

请求参数

返回参数

Device

DeviceStats

DeviceDir

DeviceStream

DirStats

示例

请求示例

返回示例

错误码

活动

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

智能视图服务

智能视图服务

接口描述

接口约束

URL

请求参数

返回参数

Device

DeviceStats

DeviceDir

DeviceStream

DirStats

示例

请求示例

返回示例

错误码