扫设备二维码(阿里云VCS定制设备),快速完成上云操作。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateScanDevice

系统规定参数。取值:CreateScanDevice。

CityCode String 100010

所要注册的设备所在的行政区域的编号。

CorpId String 3231532389897340550

所要注册设备所属的项目ID,该项目ID为您通过VCS创建时生成。

DataSourceType String PIC_VIDEO

所要注册设备的上传的数据类型:VIDEO(IPC、NVR通用数据类型)、PIC_VIDEO(阿里云定制上云宝的数据类型)。

DeviceAddress String 北京市朝阳区望京大厦

所要接入设备所在的实际地址,至少需要您录入省份和市区。

DeviceName String 望京大厦东门筒机

所要注册的设备的名称,便于分类。

DeviceSn String ca0e716429748525

扫码获取设备序列号,即SN号。

DeviceType String ABOX

所要注册的设备的类型:IPC、NVR、ABOX(该类型为阿里云定制上云宝类型)。

Latitude String 116.397128

经度;扫码设备(手机)若能自动获取经纬度,会上报该值。

Longitude String 39.916527

纬度;扫码设备(手机)若能自动获取经纬度,会上报该值。

Vendor String 阿里云

设备厂商,如海康,大华,宇视等

AccessPointVendor String vcs

接入点厂商编码,默认unv。

AccessProtocolType String GBT28181

接入协议类型,默认GBT28181。

AudioEnable String false

是否开启音频,默认开启。

DeviceDirection String 由内朝外

设备安装方向,如由内朝外。

DeviceRate String 128-16384

码率范围128-16384kbps,默认2048。

DeviceResolution String 1080P

设备分辨率,如1080P等。

DeviceSite String 东门门口

设备按照点位,如东门门口。

EncodeFormat String 6

视频或图片格式: 3: MJPEG、 6: H.264、13: H.265; 默认 6。

FrameRate String 25

设备支持的帧率,默认25。

GbId String 32000000991187000015

自有国标编码的填写,如果为空则会系统自动分配。

GovLength String 50

i帧间隔范围5-250,推荐为帧率两倍

OSDTimeEnable String 1

时间状态设置,0-关闭;1-打开;默认1。

OSDTimeType String 2

时间显示类型(可选):

0

  • YYYY-MM-DD 星期W HH:MM:SS;

    1

  • DD-MM-YYYY星期W HH:MM:SS;

    2

  • YYYY年MM月DD日 星期W HH:MM:SS;

    3

  • MM月DD日YYYY年 星期W HH:MM:SS;

    4

  • YYYY-MM-DD。
OSDTimeX String 99

时间戳X像素坐标(可选),以播放窗口左上角像素为原点,水平向右为正。

默认99,最右。

OSDTimeY String 1

时间戳Y像素坐标(可选),以播放窗口左上角像素为原点,竖直向下为正。

默认1。

SubDeviceCount Long 6

所属子设备数量。

DeviceModel String ACube200-8

所要注册设备的型号,便于分类。

返回数据

名称 类型 示例值 描述
Code String 0

返回码。

Data Struct

返回结果。

CorpId String 3231532389897340550

所要注册设备所属的项目ID,该项目ID为您通过VCS创建时生成。

DeviceCode String 13727713218900001

所注册设备的国标编码。

DeviceSn String ca0e716429748525

扫码获取设备序列号,即SN号。

SipDeviceGbId String 3356163519501303811

接入设备的国标ID。

SipGbId String 1123356163519501303811

接入网关设备国标ID。

SipIp String 119.134.11.231

接入网关设备IP。

SipPassword String Ali23411

接入统一密码。

SipPort String 8081

接入网关设备Port。

SipReaml String 20191127

接入网关域名。

SubDeviceSipInfo Array of SubDeviceSipInfo

子设备相关信息。

ChannelGbId String 3356163519501303813

通道设备国标ID。

FridayCaptureStrategy String 00:00-24:00|2|5

周五捕获策略,保留字段。

MondayCaptureStrategy String 00:00-24:00|2|5

周一捕获策略,保留字段。

SaturdayCaptureStrategy String 00:00-24:00|2|5

周六捕获策略,保留字段。

SundayCaptureStrategy String 00:00-24:00|2|5

周日捕获策略,保留字段。

ThursdayCaptureStrategy String 00:00-24:00|2|5

周二捕获策略,保留字段。

TuesdayCaptureStrategy String 00:00-24:00|2|5

周四捕获策略,保留字段。

WednesdayCaptureStrategy String 00:00-24:00|2|5

周三捕获策略,保留字段。

Message String SUCCESS

请求返回结果消息。

RequestId String null

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateScanDevice
&CityCode=100010
&CorpId=3231532389897340550
&DataSourceType=PIC_VIDEO
&DeviceAddress=北京市朝阳区望京大厦
&DeviceName=望京大厦东门筒机
&DeviceSn=ca0e716429748525
&DeviceType=BOX
&Latitude=116.397128
&Longitude=39.916527
&Vendor=阿里云
&<公共请求参数>

正常返回示例

XML格式

<Message>SUCCESS</Message>
<RequestId>null</RequestId>
<Data>
    <SipIp>119.134.11.231</SipIp>
    <SipReaml>20191127</SipReaml>
    <CorpId>3231532389897340550</CorpId>
    <DeviceSn>ca0e716429748525</DeviceSn>
    <SipDeviceGbId>3356163519501303811</SipDeviceGbId>
    <SipPort>8081</SipPort>
    <DeviceCode>13727713218900001</DeviceCode>
    <SipGbId>1123356163519501303811</SipGbId>
    <SipPassword>Ali23411</SipPassword>
    <SubDeviceSipInfo>
        <SundayCaptureStrategy>00:00-24:00|2|5</SundayCaptureStrategy>
        <ChannelGbId/>
        <MondayCaptureStrategy>00:00-24:00|2|5</MondayCaptureStrategy>
        <FridayCaptureStrategy>00:00-24:00|2|5</FridayCaptureStrategy>
        <TuesdayCaptureStrategy>00:00-24:00|2|5</TuesdayCaptureStrategy>
        <WednesdayCaptureStrategy>00:00-24:00|2|5</WednesdayCaptureStrategy>
        <ThursdayCaptureStrategy>00:00-24:00|2|5</ThursdayCaptureStrategy>
        <SaturdayCaptureStrategy>00:00-24:00|2|5</SaturdayCaptureStrategy>
    </SubDeviceSipInfo>
</Data>
<Code>0</Code>

JSON格式

{"Message":"SUCCESS","RequestId":"null","Data":{"SipIp":"119.134.11.231","SipReaml":"20191127","CorpId":"3231532389897340550","DeviceSn":"ca0e716429748525","SipDeviceGbId":"3356163519501303811","SipPort":"8081","DeviceCode":"13727713218900001","SipGbId":"1123356163519501303811","SipPassword":"Ali23411","SubDeviceSipInfo":[{"SundayCaptureStrategy":"00:00-24:00|2|5","ChannelGbId":"","MondayCaptureStrategy":"00:00-24:00|2|5","FridayCaptureStrategy":"00:00-24:00|2|5","TuesdayCaptureStrategy":"00:00-24:00|2|5","WednesdayCaptureStrategy":"00:00-24:00|2|5","ThursdayCaptureStrategy":"00:00-24:00|2|5","SaturdayCaptureStrategy":"00:00-24:00|2|5"}]},"Code":"0"}

错误码

访问错误中心查看更多错误码。