V2.5 Update DPS Device¶
更新 DPS 设备。
使用此 API 前,确保已安装 EnOS 2.4 CU2 或更新版本。
前提条件¶
确保已在 EnOS 管理控制台 中为 DPS 设备创建了主数据组和注册组。
请求格式¶
POST https://{apigw-address}/dps-service/v2.5/pvs/device?action=update
请求参数(URI)¶
名称 |
位置(Path/Query) |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|---|
orgId |
Query |
必需 |
String |
设备所属的组织 ID。如何获取 orgId 信息>> |
请求参数(Body)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
sn |
必需 |
String |
设备 SN 号,由系统生成,环境内唯一。 |
desc |
可选 |
String |
设备描述。 |
batchTag |
可选 |
StringI18n |
设备创建批次标签。国际化名称表示方法 >> |
deviceData |
可选 |
Map(Key 为 String,Value 为 Integer,String,Enum 或 Date) |
设备主数据。Key 为主数据的标识符,其 Value 必须与主数据的数据类型对应。确保已 创建该主数据,或使用 内置主数据。 |
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
data |
String |
设备 SN 号。 |
错误码¶
代码 |
错误信息 |
描述 |
---|---|---|
99400 |
Invalid Argument groupId:groupId is missing |
注册组 ID 为空/不合法。 |
99400 |
Invalid Argument count:count is missing |
创建设备数量为空。 |
99400 |
count of PvsDeviceCreateInfo must between 1 to 1000000 |
创建设备数量不合法。 |
35404 |
Group not found |
注册组不存在。 |
35601 |
Illegal deviceSn, deviceSn duplicated |
设备 SN 号已存在。 |
示例¶
请求示例¶
url: https://{apigw-address}/dps-service/v2.5/pvs/device?action=update&orgId=yourOrgId
method: POST
requestBody:
{
"sn": "yourSn",
"deviceData" : {}
}
返回示例¶
{
"code": 0,
"msg": "OK",
"requestId": "6e13b720-20d8-4ab1-8f34-060f89e569ed",
"data": [
"yourDeviceSn"
]
}