API Explorer
回调事件通知
API概览
调用方式
设备管理
查询区域列表
创建设备
删除设备
修改设备
查询设备
查询设备列表
批量删除设备
同步平台通道
设备树管理
凭证管理
模板管理
视频设备
视图设备
回调管理
AI管理
计费管理

修改设备

最近更新时间：2026-03-19 18:16:28

天翼云智能视图服务API

1.修改设备

接口功能介绍

本接口用于修改设备信息。

接口约束

无

URI

PUT /devices/{DeviceId}

路径参数

参数是否必填参数类型说明示例下级对象
DeviceId是String设备ID。32388487739092996

Query参数
无

请求参数

请求头header参数

参数是否必填参数类型说明示例下级对象
Authorization是String认证信息。CT-HMAC-SHA256 Credential=FQ01GA2RR9IJFM1PWIPR/2023-07-18/vss, SignedHeaders=content-type;host;timestamp, Signature=c6e72dffcfb2d25d276e119781e1deb6656d966702191b2bd862d1691e39394f
Content-Type是String互联网媒体类型。application/json;charset=utf-8
Host是String主机。vssapi.ctyun.cn
Version是String版本。2021-11-25
Timestamp是String时间戳。1689643309

请求体body参数

参数是否必填参数类型说明示例下级对象
InNetworkType否String接入网络类型。取值：public：互联网；private：专线网络。public
OutNetworkType否String播放网络类型，默认public。取值：public：互联网。public
Device是Object设备基本信息。Device
VideoDevice否Object视频协议设备信息。VideoDevice
ViidDevice否Object视图协议设备信息。ViidDevice

表 Device

参数是否必填参数类型说明示例下级对象
DeviceVendor否String设备厂商。取值：海康，大华，宇视，金三立，华为，科达，其他。海康
DeviceName否String设备名称，2-64位，可包含大小写字母、数字、中文、中划线、下划线、小括号、空格。摄像头
DeviceIp否String设备ip。192.168.0.1
DevicePort否Integer设备端口，范围0-65535。8000
DeviceMac否String设备mac地址，需符合通用mac地址格式。00-16-EA-AE-3C-40
DeviceSerialNumber否String设备sn码，长度不超过64位，仅ipc设备及nvr通道有效。xxx
DeviceModel否String设备型号，长度不超过64位。xxx
DeviceLongitude否String设备经度，最高精确到小数点后6位。11.11
DeviceLatitude否String设备纬度，最高精确到小数点后6位。11.11
DevicePoleId否String设备杆号，1-21位，可包含大小写字母、数字，下划线。xxx
DeviceChannelSize否Integer设备通道数量。3
Description否String设备描述，长度小于等于255个字符。描述

表 VideoDevice

参数是否必填参数类型说明示例下级对象
Gb28181Device否Object国标设备。Gb28181Device
EhomeDevice否ObjectEhome设备。EhomeDevice
RtmpDevice否ObjectRtmp设备。RtmpDevice
RtspDevice否ObjectRtsp设备。RtspDevice

表 Gb28181Device

参数是否必填参数类型说明示例下级对象
InVersion否String接入国标版本。取值：2016。2016
InUserName否String设备用户名，在创建GB28181凭证时生成。user
StreamTransProtocol否String媒体流传输协议，默认tcp。取值：tcp，udp。tcp
OutId否String设备国标ID，长度20位，不可与已有国标ID重复，当需要自定义国标ID，不需要平台自动生成国标ID时，该字段有效。11000000541327000032
AutoStartStream否Boolean是否启用自动拉流。取值：true：自动拉流，设备注册成功后自动启动拉流；false：按需拉流，需要通过触发的方式启动拉流。true
EnabledGB35114否Boolean是否启用GB35114协议。true
GB35114Mode否IntegerGB35114协议认证方式，EnabledGB35114为true时，该字段必选。取值：1：单向认证；2：双向认证。1

表 EhomeDevice

参数是否必填参数类型说明示例下级对象
InUserName否StringEhome凭证。test
AutoStartStream否Boolean是否启用自动拉流。取值：true：自动拉流，设备注册成功后自动启动拉流；false：按需拉流，需要通过触发的方式启动拉流。true
StreamSize否Integer主子码流数量，默认1，ipc设备最多支持三码流，nvr设备最多支持双码流。取值：1：单码流（仅有一种码流）；2：双码流（主、子码流）；3：三码流（主、子、第三码流）。1
StreamNum否Integer设备发送第几个码流，默认1。取值：1：主码流；2：子码流；3：第三码流。主子码流数量不能小于设备发送码流，如StreamSize为2，则StreamNum可选1或2。1

表 RtmpDevice

参数是否必填参数类型说明示例下级对象
InType否String视频流接入方式。取值：push：推流。push
PushType否Integer是否自动激活推流地址。取值：1：自动激活推流地址，设备创建完成后，平台自动生成推流地址；2：按需推流，需要通过触发的方式生成推流地址。1

表 RtspDevice

参数是否必填参数类型说明示例下级对象
InType否String视频流接入方式。取值：pull：拉流。pull
UserName否String用户名，设备厂商由其他修改为海康，大华，宇视，金三立，华为，科达时，该字段必选。test
Password否String密码，设备厂商由其他修改为海康，大华，宇视，金三立，华为，科达时，该字段必选。xxx
PullUrl否String拉流地址，自定义拉流地址，设备厂商修改为其他时，该字段必选。http://example.ctyun.cn/example
EnableDomain否Boolean是否启用域名，设备厂商由其他修改为海康，大华，宇视，金三立，华为，科达时，该字段必选。取值：true：启用；false：不启用。true
DeviceDomain否String设备域名，设备厂商由其他修改为海康，大华，宇视，金三立，华为，科达且启用域名时，该字段必选。xxx
DeviceIp否String设备IP，设备厂商由其他修改为海康，大华，宇视，金三立，华为，科达且不启用域名时，该字段必选。192.168.0.1
DevicePort否Integer设备Port，范围0-65535，设备厂商由其他修改为海康，大华，宇视，金三立，华为，科达时，该字段必选。554
StreamTransProtocol否String媒体流传输协议，默认tcp。取值：tcp，udp。tcp
AutoStartStream否Boolean是否启用自动拉流。取值：true：自动拉流，设备注册成功后自动启动拉流；false：按需拉流，需要通过触发的方式启动拉流。true
StreamSize否Integer主子码流数量，默认1，设备厂商为其他时，该字段请置空。取值：1：单码流（仅有一种码流）；2：双码流（主、子码流）；3：三码流（主、子、第三码流）。1
StreamNum否Integer设备发送第几个码流，默认1，设备厂商为其他时，该字段请置空。取值：1：主码流；2：子码流；3：第三码流。主子码流数量不能小于设备发送码流，如StreamSize为2，则StreamNum可选1或2。1

表 ViidDevice

参数是否必填参数类型说明示例下级对象
Ga1400Device否ObjectGa1400设备。Ga1400Device

表 Ga1400Device

参数是否必填参数类型说明示例下级对象
InUserId是StringGa1400凭证id，在创建视图凭证时生成，可在用户控制台【凭证管理-GA1400凭证】页面获取。20720122
DeviceType否String视图库设备类型。取值：ape：采集设备。ape

响应参数

参数参数类型说明示例下级对象
statusCodeInteger响应状态码。200
errorString错误码，执行成功时，不返回该字段。VSS_0001
messageString响应信息。请求成功
requestIdString请求ID。362d4e78556b47129182d0881fade86b
returnObjObject响应数据，执行失败时，不返回该字段。returnObj

表 returnObj

参数参数类型说明示例下级对象
DeviceObject设备信息。Device
VideoDeviceObject视频协议设备信息。VideoDevice
ViidDeviceObject视图协议设备信息。ViidDevice
CreatedTimeString设备创建时间。1685515845343
UpdatedTimeString设备更新时间。1685516000079
RequestIdString请求ID。362d4e78556b47129182d0881fade86b

表 Device

参数参数类型说明示例下级对象
DeviceIdString设备ID。32388487739092996
DeviceChannelsArray of Objects设备通道列表。DeviceChannel

表 DeviceChannel

参数参数类型说明示例下级对象
DeviceIdString设备ID。32388487739092996
OutIdString设备国标ID。11000000541327000032
DeviceChannelNumInteger通道号。1
DeviceNameString通道名称。通道1

表 VideoDevice

参数参数类型说明示例下级对象
Gb28181DeviceObject国标设备。Gb28181Device
EhomeDeviceObjectEhome设备。EhomeDevice
RtmpDeviceObjectRtmp设备。RtmpDevice
RtspDeviceObjectRtsp设备。RtspDevice

表 Gb28181Device

参数参数类型说明示例下级对象
InVersionString接入国标版本。2016
OutIdString设备国标ID。11000000541327000032
SipIdString国标SIP服务器ID。52010000012008589806
SipIpString国标SIP服务器IP。192.168.0.1
SipTcpPortInteger国标SIP服务器TCP端口。15064
SipUdpPortInteger国标SIP服务器UDP端口。15064
SipTransTypeString国标SIP服务器传输协议。tcp
AutoStartStreamBoolean是否启用自动拉流。true
StreamSizeInteger主子码流数量。1
StreamNumInteger设备发送第几个码流。1

表 EhomeDevice

参数参数类型说明示例下级对象
InVersionString接入Ehome版本。2.0
OutIdString设备国标ID。11000000541327000032
SipIdString国标SIP服务器ID。52010000012008589806
SipIpString国标SIP服务器IP。192.168.0.1
SipTcpPortInteger国标SIP服务器TCP端口。15064
SipUdpPortInteger国标SIP服务器UDP端口。15064
SipTransTypeString国标SIP服务器传输协议。tcp
AutoStartStreamBoolean是否启用自动拉流。true
StreamSizeInteger主子码流数量。1
StreamNumInteger设备发送第几个码流。1

表 RtmpDevice

参数参数类型说明示例下级对象
OutIdString视频流接入方式。push
PushTypeInteger是否自动激活推流地址。1
PushUrlString推流地址。http://example.ctyun.cn/example

表 RtspDevice

参数参数类型说明示例下级对象
OutIdString设备国标ID。11000000541327000032
EnableDomainBoolean是否启用域名。true
DeviceDomainString设备域名。xxx
DeviceIpString设备IP。192.168.0.1
DevicePortInteger设备Port。554
AutoStartStreamBoolean是否启用自动拉流。true
StreamSizeInteger主子码流数量。1
StreamNumInteger设备发送第几个码流。1

表 ViidDevice

参数参数类型说明示例下级对象
Ga1400DeviceObjectGa1400设备。Ga1400Device

表 Ga1400Device

参数参数类型说明示例下级对象
OutIdString设备视图编码。11000000541327000032
ViidIpString视图库ip。192.168.0.1
ViidPortInteger视图库端口。8000

请求示例

请求url

PUT '/devices/743780360209498112'

请求头header

{
    "Authorization": "CT-HMAC-SHA256 Credential=FQ01GA2RR9IJFM1PWIPR/2023-07-18/vss, SignedHeaders=content-type;host;timestamp, Signature=c6e72dffcfb2d25d276e119781e1deb6656d966702191b2bd862d1691e39394f",
    "Content-Type": "application/json;charset=utf-8",
    "Host": "vssapi.ctyun.cn",
    "Version": "2021-11-25",
    "Timestamp": "1689643309"
}

请求体body

{
  "InNetworkType": "public",
  "OutNetworkType": "public",
  "Device": {
    "DeviceVendor": "海康",
    "DeviceName": "openapi-v2",
    "DeviceLongitude": "0.000000",
    "DeviceLatitude": "0.000000",
    "DeviceIp": "",
    "DeviceMac": "",
    "DevicePoleId": "",
    "DeviceSerialNumber": "",
    "DeviceModel": "",
    "Description": "",
    "DeviceChannelSize": 1
  },
  "VideoDevice": {
    "Gb28181Device": {
      "InVersion": "2016",
      "InUserName": "123",
      "StreamTransProtocol": "tcp",
      "AutoStartStream": true
    }
  }
}

响应示例

{
  "statusCode": 200,
  "message": "请求成功",
  "requestId": "100fdd8148184b23baeddc3510d12d6e",
  "returnObj": {
    "Device": {
      "DeviceId": "743780360209498112",
      "DeviceChannels": []
    },
    "VideoDevice": {
      "Gb28181Device": {
        "InVersion": "2016",
        "OutId": "11000000541327000032",
        "SipId": "52010000012008589806",
        "SipIp": "vssapi.ctyun.cn",
        "SipTcpPort": "15064",
        "SipUdpPort": "15064",
        "SipTransType": "tcp",
        "StreamSize": 1,
        "AutoStartStream": true,
        "StreamNum": 1,
        "EnabledGB35114": false,
        "GB35114Mode": 0
      },
      "EhomeDevice": null,
      "RtmpDevice": null,
      "RtspDevice": null
    },
    "ViidDevice": null,
    "IotDevice": null,
    "CreatedTime": "1685515845343",
    "UpdatedTime": "1685515845343",
    "RequestId": "100fdd8148184b23baeddc3510d12d6e"
  }
}

状态码

请参考状态码说明。

错误码

请参考错误码说明。

上一篇：删除设备 下一篇：查询设备
本页目录：