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

创建设备

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

天翼云智能视图服务API

1.创建设备

接口功能介绍

本接口用于创建设备。

接口约束

创建设备前，请确认账号已开通计费资源。 ehome协议nvr类型设备，不能自动创建子通道，需设备注册成功后手动配置。

URI

POST /devices

路径参数
无

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参数

参数是否必填参数类型说明示例下级对象
Region是String设备接入区域，辽阳1区域ID：21100001。21100001
InNetworkType是String接入网络类型。取值：public：互联网；private：专线网络。public
OutNetworkType否String播放网络类型，默认public。取值：public：互联网。public
Device是Object设备基本信息。Device
VideoDevice否Object视频协议设备信息（GB28181/RTSP/RTMP/EHOME）。VideoDevice
ViidDevice否Object视图协议设备信息（GA1400）。ViidDevice
Resource否Object资源包信息，设备类型为视频设备ipc或nvr时，该字段必选。Resource

表 Device

参数是否必填参数类型说明示例下级对象
DirId否String设备所属目录ID。600001
DeviceType是String设备类型。取值：ipc，nvr，platform。nvr
DeviceVendor是String设备厂商，ehome设备仅支持海康，仅rtsp设备支持金三立，华为，科达。取值：海康，大华，宇视，金三立，华为，科达，其他。海康
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设备有效。xxx
DeviceModel否String设备型号，长度不超过64位。xxx
DeviceLongitude否String设备经度，最高精确到小数点后6位。11.11
DeviceLatitude否String设备纬度，最高精确到小数点后6位。11.11
DevicePoleId否String设备杆号，1-21位，可包含大小写字母、数字、下划线。xxx
InOrgRegion是Integer设备中心编码（8位），按照设备安装所在地的行政区划代码确定，当不是基层单位时空余位为0。行政区划代码采用GB/T 2260-2007规定的行政区划代码表示。35010200
InOrgRegionLevel是Integer设备中心编码级别，取值：1、2、3。3
DeviceIndustryCode是String设备所属行业编码。取值：08:城市管理; 09:卫生环保; 10:商检海关; 11:教育部门; 40:农林牧渔业; 41:采矿企业; 42:制造企业; 43:冶金企业; 44:电力企业; 45:燃气企业; 46:建筑企业; 47:物流企业; 48:邮政企业; 49:信息企业; 50:住宿和餐饮业; 51:金融企业; 52:房地产业; 53:商务服务业; 54:水利企业; 55:娱乐企业; 80:居民自建; 99:其他主体。08
DeviceNetworkCode是String设备所属网络标识。取值：0、1、2、3、4：监控报警专网；5：公安信息网；6：政务网；7：Internet网；8：社会资源接入网。7
AutoCreateChannel否Boolean是否自动创建子设备，设备类型为nvr时，该字段必选。取值：true：自动创建。true
DeviceChannelSize否Integer设备通道数量，AutoCreateChannel为true时，该字段有效且必选。创建ehome协议nvr类型设备时忽略该字段。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凭证时生成。创建GB28181设备时该字段必填，创建GB35114设备时不需要该字段。user
StreamTransProtocol否String媒体流传输协议，默认tcp。取值：tcp，udp。tcp
OutId否String设备国标ID，长度20位，不可与已有国标ID重复，当需要自定义国标ID时，该字段有效。51030300101327015065
AutoStartStream否Boolean是否启用自动拉流。取值：true：自动拉流，设备注册成功后自动启动拉流；false：按需拉流，需要通过触发的方式启动拉流。true
EnabledGB35114否Boolean是否启用GB35114协议。true
GB35114Mode否IntegerGB35114协议认证方式，EnabledGB35114为true时，该字段必选。取值：1：单向认证；2：双向认证。1

表 EhomeDevice

参数是否必填参数类型说明示例下级对象
InVersion是String接入Ehome版本。取值：2.0。2.0
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：不启用。默认值为false。false
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

表 Resource

参数是否必填参数类型说明示例下级对象
Video否Array of Objects视频资源。创建视频设备（GB28181/RTSP/RTMP/EHOME）时须配置视频资源。VideoResource
Viid否Array of Objects视图资源。创建视图设备（GA1400）时须配置视图资源。ViidResource
AI否Array of ObjectsAI资源。仅视频设备（GB28181/RTSP/RTMP/EHOME）可配置AI资源。AIResource

表 VideoResource

参数是否必填参数类型说明示例下级对象
BillingMode是String付费模式。取值：packages：资源包；onDemand：按需计费。packages
ResourceId否String资源Id，付费模式为packages时，该字段必选。resource-01
RecordNum否String录制配置，付费模式为onDemand时，该字段必选。取值：0：无录制；1：录制。1
TemplateId否String模板Id，付费模式为onDemand且录制配置为1时，该字段必选。707389832455651328
ChannelNum否String通道号，设备类型是nvr时，该字段必选。1

表 ViidResource

参数是否必填参数类型说明示例下级对象
BillingMode是String付费模式。取值：onDemand：按需计费。onDemand
TemplateId是String视图存储模板Id，付费模式为onDemand时，该字段必选,可在用户控制台【模板管理-存储模板-视图存储模板】页面获取。717074786139029504

表 AIResource

参数是否必填参数类型说明示例下级对象
BillingMode是String付费模式。取值：packages：资源包；onDemand：按需计费。packages
ResourceId否String资源Id，付费模式为packages时，该字段必选。resource-AI-01
AppId是StringAI应用Id，可在用户控制台【AI管理-AI应用-应用详情】页面获取。609
AnalyseType是String应用分析类型，可在用户控制台【AI管理-AI应用-应用详情】页面获取。付费模式为packages时，AI应用的分析能力不应超过资源包所具有的分析能力。取值：AI-100：分钟级；AI-200：秒级；AI-300：高算力。AI-100

响应参数

参数参数类型说明示例下级对象
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。34082400011188226858
DeviceChannelNumInteger通道号。1
DeviceNameString通道名称。通道1

表 VideoDevice

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

表 Gb28181Device

参数参数类型说明示例下级对象
InVersionString接入国标版本。2016
OutIdString设备国标ID。34082400011188226858
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。34082400011188226858
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设备国标ID。34082400011188226858
PushTypeInteger是否自动激活推流地址。1
PushUrlString推流地址。http://example.ctyun.cn/example

表 RtspDevice

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

表 ViidDevice

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

表 Ga1400Device

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

请求示例

请求url

POST '/devices'

请求头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

{
  "Region": "0851001",
  "InNetworkType": "public",
  "OutNetworkType": "public",
  "Device": {
    "DeviceType": "ipc",
    "DeviceVendor": "海康",
    "DeviceName": "openapi-v2",
    "DeviceLongitude": "0.000000",
    "DeviceLatitude": "0.000000",
    "DeviceIp": "",
    "DeviceMac": "",
    "DevicePoleId": "",
    "DeviceSerialNumber": "",
    "DeviceModel": "",
    "Description": "",
    "DeviceChannelSize": 1,
    "InOrgRegion": 11000000,
    "InOrgRegionLevel": 1,
    "DeviceIndustryCode": "54",
    "DeviceNetworkCode": "7"
  },
  "Resource": {
    "Video": [{
      "BillingMode": "packages",
      "ResourceId": "resource01"
    }]
  },
  "VideoDevice": {
    "Gb28181Device": {
      "InVersion": "2016",
      "InUserName": "123",
      "StreamTransProtocol": "tcp",
      "AutoStartStream": true
    }
  }
}

响应示例

{
  "statusCode": 200,
  "message": "请求成功",
  "requestId": "5c94e21e87654e408921a6437e880db1",
  "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
      },
      "EhomeDevice": null,
      "RtmpDevice": null,
      "RtspDevice": null
    },
    "ViidDevice": null,
    "CreatedTime": "1685515845343",
    "UpdatedTime": "1685515845343",
    "RequestId": "5c94e21e87654e408921a6437e880db1"
  }
}

状态码

请参考状态码说明。

错误码

请参考错误码说明。

上一篇：查询区域列表 下一篇：删除设备
本页目录：