注册终端设备 - CreateDevice
功能介绍
该API用于注册一个终端设备。
请求消息
请求参数
参数 | 是否必选 | 类型 | 描述 |
|---|---|---|---|
Content-Type | 是 | String | 消息体的类型（格式） 推荐您使用默认值application/json。 |
X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
ief-instance-id | 否 | String | 企业版实例ID，专业版实例为空值 |
名称 | 是否必选 | 参数类型 | 说明 |
|---|---|---|---|
device | 是 | 表4 object | 终端设备信息 |
参数 | 是否必选 | 类型 | 描述 |
|---|---|---|---|
id | 否 | String | 终端设备ID，只允许英文字母、数字、下划线、中划线，必须以英文字母和数字开头，长度限制为24~64之间 |
name | 是 | String | 终端设备名称，只允许中文字符、英文字母、数字、下划线、中划线，长度限制为1~64 |
description | 否 | String | 终端设备描述，最大长度255，不允许^ ~ # $ % & * < > ( ) [ ] { } ' " \ |
attributes | 否 | Object | 静态属性，最多64个键值。 key为属性名称，value格式请参见表6，示例如下。 "attributes": {
"username": {
"value": "test",
"optional": true,
"metadata": {
"type": "string"
}
}
} |
connection_type | 否 | String | 连接类型，默认为edge |
access_protocol | 否 | String | 访问协议，有如下选项：
默认为userdefine |
twin | 否 | Object | 动态属性，最多64个键值。 key为属性名称，value格式请参见表7，示例如下。 "twin": {
"devicestate": {
"optional": true,
"expected": {
"value": "running"
},
"metadata": {
"type": "string"
}
}
} |
access_config | 否 | 表24 object | 访问配置，与access_protocol直接关联。 |
property_visitors | 否 | Object | 孪生属性配置，key为对应孪生属性的key，value格式请参见表25 |
请求示例
{
"device": {
"access_protocol": "userdefine",
"name": "device",
"connection_type": "edge",
"description": "",
"attributes": {}
}
} 响应消息
参数 | 类型 | 描述 |
|---|---|---|
device | 表6 object | 终端设备详细信息 |
名称 | 参数类型 | 说明 |
|---|---|---|
id | String | 终端设备ID |
name | String | 终端设备名称 |
access_protocol | String | 访问协议 |
description | String | 终端设备描述 |
project_id | String | 项目ID |
created_at | String | 创建时间 |
updated_at | String | 更新时间 |
attributes | Object | 静态属性，最多64个键值。 key为属性名称，value格式请参见表6，示例如下。 "attributes": {
"username": {
"value": "test",
"optional": true,
"metadata": {
"type": "string"
}
}
} |
twin | Object | 动态属性，最多64个键值。 key为属性名称，value格式请参见表21，示例如下。 "devicestate":{
"expected":{
"value":"running",
"metadata":{
"timestamp":1536822119463
}
},
"optional":true,
"metadata":{ "type":"string" }
} |
access_config | 表24 object | 访问配置，与access_protocol直接关联。 |
property_visitors | Object | 孪生属性配置，与access_protocol关联。key为属性名称，value格式请参见表25 |
connection_type | String | 连接类型，默认为edge |
响应示例
{
"device": {
"id": "1398f13d-f24d-4de4-8cd3-5905db1d6d9f",
"name": "device",
"access_protocol": "",
"project_id": "05e1aef9040010e22fccc009adecb056",
"description": "",
"created_at": "2020-09-23T02:00:22.858736Z",
"updated_at": "",
"access_config": {},
"connection_type": "edge"
}
} 错误码
请参见错误码。
