You need to enable JavaScript to run this app.
导航

查看设备信息

最近更新时间2023.07.21 14:45:51

首次发布时间2021.11.25 17:21:23

查询指定设备的信息。

请求方式

使用 GET 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表,参考「公共参数」。

字段
位置
类型
必填
说明
ActionQueryString公共参数,OpenAPI 接口名称GetDevice
VersionQueryString公共参数,OpenAPI 接口版本2021-01-01
DeviceIDQueryString设备 ID可通过调用 ListDevices 接口获取

SipServerID

Query

String

Sip 服务器 ID

可在「视联网控制台 - 设备管理 - SIP信息」中获取

与 SpaceID 二选一,以 SipServerID 优先

SpaceID

Query

String

空间 ID

可通过调用 ListSpaces 接口获取

与 SipServerID 二选一,以 SipServerID 优先

返回结果

返回参数说明

通用返回参数,请参考 ResponseMetadata 结构体说明

Result 字段包含以下参数:

字段
类型
说明
SpaceIDString设备所属空间 ID

Type

String

设备类型:

  • IPC
  • NVR
  • Platform(平台)
DeviceNameString设备名称
DeviceIDString设备 ID
DeviceNSIDString设备国标 ID
UsernameString用户名
PasswordString密码

Status

String

设备状态:

  • online
  • offline
  • unregisterd
  • invalid_password
ChannelNumInteger通道数量
DescriptionString设备描述

AutoPullAfterRegister

Boolean

是否自动启动拉流:

  • true(开启)
  • False(关闭)
CreatedAtTimestamp设备创建时间
UpdatedAtTimestamp设备更新时间
ManufactoryString设备厂商
AlertNotificationArray of Boolean设备报警事件通知方式,参考以下 报警通知结构说明
DeviceIPString设备 IP 地址

RtpTransportTcp

Boolean

流媒体传输是否使用 TCP 协议:

  • true:是(tcp,默认)
  • false:否(udp)
LocationString设备地址
CoordinatesObjects设备经纬度,参考以下 经纬度结构说明
DeviceStreamsObject主码流信息,参考以下 码流信息结构说明
DeviceSubStreamsArray of Objects子码流数组,数组下标为子码流序号(如子码流1取数组第1个元素);参考以下 码流信息结构说明
UseSubStreamBoolean是否使用子码流, 开启后可以拉取子码流

报警通知结构说明

字段
类型
说明

Enabled

Boolean

是否开启报警通知服务:

  • true:开启报警,至少包含一种报警类型
  • false:关闭报警通知服务
PhoneBoolean电话报警
DeviceBoolean设备报警
SMSBoolean短信报警
GPSBooleanGPS 报警
VideoBoolean视频报警
DeviceFaultBoolean设备故障报警
OtherBoolean其它报警

经纬度结构说明

字段
类型
说明
LongitudeFloat64经度
LatitudeFloat64纬度

码流信息结构说明

字段
类型
说明
StreamIDString视频流 ID
PullUrlsString[]拉流地址
PushUrlString推流地址

Status

String

视频流状态:

  • online:在线
  • offline:离线

示例

请求示例

GET https://open.volcengineapi.com?Action=GetDevice
&Version=2021-01-01
&DeviceID=6851c282-c7f6-4a04-90f9-d9c8baxxxxxx
&SipServerID=34020000002000xxxxxx
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021120814224701019405910015015954",
        "Action": "GetDevice",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "SpaceID": "2db38a3a-2a9d-4bf7-afd9-7cdc13xxxxxx",
        "Type": "IPC",
        "DeviceName": "SH-HK-IPC01",
        "DeviceID": "6851c282-c7f6-4a04-xxxx-xxxx",
        "DeviceNSID": "34020056991320xxxxxx",
        "Username": "34020056991320xxxxxx",
        "Password": "xxxxxx",
        "Status": "online",
        "ChannelNum": 1,
        "Description": "Camera001",
        "AutoPullAfterRegiter": false,
        "Manufactory": "ABC",
        "CreatedAt": "2021-12-08T14:06:58+08:00",
        "UpdatedAt": "2021-12-08T14:06:58+08:00",
        "AlertNotification": {
            "Enabled": false,
            "Phone": false,
            "Device": false,
            "SMS": false,
            "GPS": false,
            "Video": false,
            "DeviceFault": false,
            "Other": false
        },
        "DeviceIP": "xx.xxx.xxx.xx",
        "RtpTransportTcp": true,
        "Location": "",
        "Coordinates": {
            "Longitude": 0,
            "Latitude": 0
        },
        "DeviceStreams": {
            "3402002xxxxxx1000001": {
            "StreamID": "f3275626-5b49-4614-b667-65c8ecxxxxxx",
            "PullUrls": [
                "rtmp://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001",
                "http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.flv",
                "http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.m3u8",
                "http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.sdp"
            ],
            "PushUrl": "rtmp://xxxx.fcdn-xxx-push.org/xxxx/xxx000001?Time=1681798490&Secret=xxx",
            "Status": "online"
            }
        },
        "DeviceSubStreams": {
            "3402002xxxxxx1000001": [
                {
                "StreamID": "f3275626-5b49-4614-b667-65c8ecxxxxxx",
                "PullUrls": [
                "rtmp://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001",
                "http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.flv",
                "http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.m3u8",
                "http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.sdp"
                ],
                "PushUrl": "rtmp://xxxx.fcdn-xxx-push.org/xxxx/xxx000001?Time=1681798490&Secret=xxx",
                "Status": "online"
                }
            ],
            "3402002xxxxxx1000002": [
                {
                "StreamID": "f3275626-5b49-4614-b667-65c8ecxxxxxx",
                "PullUrls": [
                "rtmp://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001",
                "http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.flv",
                "http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.m3u8",
                "http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.sdp"
                ],
                "PushUrl": "rtmp://xxxx.fcdn-xxx-push.org/xxxx/xxx000001?Time=1681798490&Secret=xxx",
                "Status": "online"
                }
              ]
           },
       "UseSubStream": true
    }
}