文档中心 > API类目 > 智慧园区API

alibaba.campus.device.openapi.createdevice (创建设备)

创建设备

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
work_bench_context WorkBenchContext 可选 运行上下文
  • └ eagle_eye_trace_id
  • String
  • 可选
  • 1
  • 鹰眼id
  • └ company_id
  • Number
  • 必须
  • 100001
  • 公司id
  • └ system_id
  • String
  • 可选
  • sys123
  • 系统id
  • └ campus_code
  • String
  • 可选
  • xixi
  • 园区code
  • └ ip
  • String
  • 可选
  • 192.168.0.1
  • ip
  • └ campus_id
  • Number
  • 可选
  • 111
  • 园区id
  • └ security_code
  • String
  • 可选
  • aa
  • 安全code
  • └ language
  • String
  • 可选
  • zh
  • 语言
  • └ app_code
  • String
  • 可选
  • a
  • appCode
  • └ user_name
  • String
  • 可选
  • 昭云
  • 用户名称
  • └ user_id
  • Number
  • 必须
  • 123
  • 用户id
device_standard_api_dto DeviceStandardApiDTO 可选 设备信息
  • └ be_logic
  • Boolean
  • 必须
  • false
  • 是否为逻辑设备
  • └ connector_id
  • Number
  • 可选
  • 47
  • 边缘id,云上设备不填
  • └ template_id
  • Number
  • 可选
  • 163
  • 模版id
  • └ floor_id
  • Number
  • 可选
  • 100023
  • 楼层id
  • └ longitude
  • String
  • 可选
  • 43.23
  • 经度
  • └ company_id
  • Number
  • 可选
  • 100001
  • 公司id
  • └ connector_name
  • String
  • 可选
  • connector45
  • 边缘名称
  • └ code
  • String
  • 必须
  • 环境传感器
  • 设备编号
  • └ latitude
  • String
  • 可选
  • 34.23
  • 纬度
  • └ description
  • String
  • 可选
  • 描述信息
  • 描述信息
  • └ template_code
  • String
  • 可选
  • Face_Detector_Cam
  • 模版code
  • └ space_id
  • Number
  • 可选
  • 100023
  • 空间id
  • └ device_protocol_json_value
  • String
  • 必须
  • {"":""}
  • 设备协议
  • └ nickname
  • String
  • 可选
  • 环境传感器
  • 设备名称
  • └ be_run
  • Boolean
  • 可选
  • true
  • 启用停用
  • └ cloud_config_protocol
  • Boolean
  • 可选
  • true
  • 是否云上配置协议
  • └ kind_id
  • Number
  • 必须
  • 163
  • 设备模版id
  • └ connector_type
  • Number
  • 可选
  • 1
  • 连接类型
  • └ campus_id
  • Number
  • 可选
  • 100001
  • 园区id
  • └ building_id
  • Number
  • 可选
  • 100006
  • 楼宇id

响应参数

名称 类型 示例值 描述
result PojoResult 返回结果
  • └ error_ext_info
  • String
  • {"":""}
  • 错误扩展信息
  • content
  • DeviceStandardApiDTO
  • 内容
  • └ code
  • String
  • 测试设备
  • test
  • └ uuid
  • String
  • aaaa-bbbb
  • 设备uuid
  • └ error_msg
  • String
  • 创建失败
  • 错误信息
  • └ error_level
  • String
  • error
  • 错误级别
  • └ success
  • Boolean
  • true
  • 业务成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaCampusDeviceOpenapiCreatedeviceRequest req = new AlibabaCampusDeviceOpenapiCreatedeviceRequest();
AlibabaCampusDeviceOpenapiCreatedeviceRequest.WorkBenchContext obj1 = new AlibabaCampusDeviceOpenapiCreatedeviceRequest.WorkBenchContext();
obj1.setEagleEyeTraceId("1");
obj1.setCompanyId(100001L);
obj1.setSystemId("sys123");
obj1.setCampusCode("xixi");
obj1.setIp("192.168.0.1");
obj1.setCampusId(111L);
obj1.setSecurityCode("aa");
obj1.setLanguage("zh");
obj1.setAppCode("a");
obj1.setUserName("昭云");
obj1.setUserId(123L);
req.setWorkBenchContext(obj1);
AlibabaCampusDeviceOpenapiCreatedeviceRequest.DeviceStandardApiDTO obj2 = new AlibabaCampusDeviceOpenapiCreatedeviceRequest.DeviceStandardApiDTO();
obj2.setBeLogic(false);
obj2.setConnectorId(47L);
obj2.setTemplateId(163L);
obj2.setFloorId(100023L);
obj2.setLongitude("43.23");
obj2.setCompanyId(100001L);
obj2.setConnectorName("connector45");
obj2.setCode("环境传感器");
obj2.setLatitude("34.23");
obj2.setDescription("描述信息");
obj2.setTemplateCode("Face_Detector_Cam");
obj2.setSpaceId(100023L);
obj2.setDeviceProtocolJsonValue("{\"\":\"\"}");
obj2.setNickname("环境传感器");
obj2.setBeRun(true);
obj2.setCloudConfigProtocol(true);
obj2.setKindId(163L);
obj2.setConnectorType(1L);
obj2.setCampusId(100001L);
obj2.setBuildingId(100006L);
req.setDeviceStandardApiDto(obj2);
AlibabaCampusDeviceOpenapiCreatedeviceResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_campus_device_openapi_createdevice_response>
    <result>
        <error_ext_info>{&quot;&quot;:&quot;&quot;}</error_ext_info>
        <content>
            <code>测试设备</code>
            <uuid>aaaa-bbbb</uuid>
        </content>
        <error_msg>创建失败</error_msg>
        <error_level>error</error_level>
        <success>true</success>
    </result>
</alibaba_campus_device_openapi_createdevice_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部