更新时间:2024-07-03 GMT+08:00

创建设备

功能介绍

在ROMA Connect创建设备。

URI

POST /v1/{project_id}/link/instances/{instance_id}/devices

表1 参数说明

名称

类型

是否必填

描述

project_id

string

租户每个区域对应的项目ID。

instance_id

string

租户使用ROMA Connect的实例ID。

请求消息

请求参数

表2 Body参数

参数

类型

是否必填

说明

product_name

string

系统中已经创建好的产品的产品名。

devices

Array<device>

设备信息。

表3 device

参数

类型

是否必填

说明

device_name

string

设备名称,支持英文大小写,数字,下划线和中划线,不超过64个字符。

remark

string

描述信息,不能超过200个字符。

status

integer

设备状态,默认值为0,只能输入0或1。

  • 0表示启用设备。
  • 1表示停用设备。

请求示例

https://example.cloud.com/v1/80e2b******f4a398d6409a50932d917/link/instances/fb3b24ab-5d87-473d-9c57-fc6******6a1/devices 
{ 
    "product_name" : "product01",
    "devices" : [
    {
        "device_name" : "device01",
        "remark" : "",
        "status" : 0
    }
    ]
}

响应消息

响应参数

响应参数为数组元素。

表4 响应参数

名称

类型

描述

数组元素

Array<device>

设备信息。

表5 device

名称

类型

描述

client_id

string

客户端ID。

device_id

integer

设备ID。

device_name

string

设备名称,支持英文大小写、数字、下划线和中划线,不超过64个字符。

password

string

密码。

product_id

integer

产品ID。

product_name

string

产品名。

remark

string

描述信息,不能超过200个字符。

status

integer

设备状态,0或1。

  • 0表示启用设备。
  • 1表示停用设备。

user_name

string

用户名。

响应示例

[
   {
       "client_id": "D2096b22290ddd4e",
       "device_id": 868,
       "device_name": "device-ada",
       "password": "*****************",
       "product_id": 209,
       "product_name": "product-ada1",
       "remark": "",
       "status": 0,
       "user_name": "5b24c8a0fb5a4416af1640bb1d25e294"
   }
]