设备管理 IoTDM(联通用户专用)设备管理 IoTDM(联通用户专用)

计算
弹性云服务器 ECS
裸金属服务器 BMS
云手机 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器 HECS
VR云渲游平台 CVR
特惠算力专区
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属企业存储服务
云存储网关 CSG
专属分布式存储服务 DSS
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘小站 IES
智能边缘平台 IEF
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
园区智能体 CampusGo
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
视频分析服务 VAS
语音交互服务 SIS
知识图谱 KG
人证核身服务 IVS
IoT物联网
设备接入 IoTDA
设备管理 IoTDM(联通用户专用)
全球SIM联接 GSL
IoT开发者服务
IoT数据分析
车联网服务 IoV
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
开发与运维
软件开发平台 DevCloud
项目管理 ProjectMan
代码托管 CodeHub
流水线 CloudPipeline
代码检查 CodeCheck
编译构建 CloudBuild
部署 CloudDeploy
云测 CloudTest
发布 CloudRelease
移动应用测试 MobileAPPTest
CloudIDE
Classroom
开源镜像站 Mirrors
应用魔方 AppCube
云性能测试服务 CPTS
应用管理与运维平台 ServiceStage
云应用引擎 CAE
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
资源管理服务 RMS
应用身份管理服务 OneAccess
区块链
区块链服务 BCS
可信跨链服务 TCS
智能协作
IdeaHub
开发者工具
SDK开发指南
API签名指南
DevStar
HCloud CLI
Terraform
Ansible
API问题定位指导
云生态
云市场
合作伙伴中心
华为云培训中心
其他
管理控制台
消息中心
产品价格详情
系统权限
我的凭证
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
应用编排服务 AOS
多云容器平台 MCP
基因容器 GCS
容器洞察引擎 CIE
云原生服务中心 OSC
容器批量计算 BCE
容器交付流水线 ContainerOps
应用服务网格 ASM
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB (for openGauss)
云数据库 GaussDB(for MySQL)
云数据库 GaussDB NoSQL
数据管理服务 DAS
数据库和应用迁移 UGO
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据湖治理中心 DGC
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
API网关 APIG
分布式缓存服务 DCS
分布式消息服务RocketMQ版
企业应用
域名注册服务 Domains
云解析服务 DNS
云速建站 CloudSite
网站备案
华为云WeLink
会议
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMAExchange
API全生命周期管理 ROMA API
安全与合规
安全技术与应用
DDoS防护 ADS
Web应用防火墙 WAF
云防火墙 CFW
应用信任中心 ATC
企业主机安全 HSS
容器安全服务 CGS
云堡垒机 CBH
数据库安全服务 DBSS
数据加密服务 DEW
数据安全中心 DSC
云证书管理服务 CCM
SSL证书管理 SCM
漏洞扫描服务 VSS
态势感知 SA
威胁检测服务 MTD
管理检测与响应 MDR
安全治理云图 Compass
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
专属云
专属计算集群 DCC
解决方案
高性能计算 HPC
SAP
游戏云
混合云灾备
华为工业云平台 IMC
价格
成本优化最佳实践
专属云商业逻辑
用户服务
帐号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
更新时间:2021-07-08 GMT+08:00
分享

修改设备信息

接口说明

应用服务器在物联网平台注册设备后,若设备的基本信息发生变更,可调用此接口在物联网平台修改设备的基本信息,包括设备类型、设备模型、厂商信息、接入协议等。

URI

请求方法

PUT

URI

/iocm/app/dm/v1.4.0/devices/{deviceId}

传输协议

HTTPS

请求参数

参数

必选/可选

类型

位置

描述

app_key

必选

String

header

访问物联网平台的应用ID,在物联网平台创建应用时由平台分配获得。

Authorization

必选

String

header

访问物联网平台的认证信息,值为“Bearer {accessToken}”,其中{accessToken}为调用鉴权接口返回的accessToken。

deviceId

必选

String

path

设备ID,用于唯一标识一个设备,在注册设备时由物联网平台分配获得。

appId

可选

String

query

设备所属的应用ID,当修改授权应用下的设备信息时才需要填写。

customFields

可选

List<CustomField>

Body

自定义字段列表,用户可设置自定义字段。

deviceConfig

可选

DeviceConfigDTO

body

设备配置信息。

deviceType

可选

String(1~256)

body

设备类型,大驼峰命名方式,例如:MultiSensor、ContactSensor、CameraGateway。

endUser

可选

String(1~256)

body

终端用户,若为直连设备,则endUser可选;若为非直连设备,则endUser可以为null。

location

可选

String(1~1024)

body

设备位置。

productId

可选

String(256)

Body

设备所属的产品ID。

manufacturerId

可选

String(1~256)

body

厂商ID,唯一标识一个厂商。

manufacturerName

可选

String(1~256)

body

厂商名称。

model

可选

String(1~256)

body

设备型号,由厂商定义。

mute

可选

String(1-256)

body

表示设备是否处于冻结状态,即设备上报数据时,平台是否会管理和保存。

  • TRUE:冻结状态
  • FALSE:非冻结状态

name

可选

String(1~256)

body

设备名称。

organization

可选

String(1~256)

body

设备所属的组织信息。

protocolType

可选

String(1~256)

body

设备使用的协议类型,当前支持的协议类型:CoAP,LWM2M,MQTT。

region

可选

String(1~256)

body

设备区域信息。

timezone

可选

String(1~256)

body

设备所在时区信息,使用时区编码,如Asia/Shanghai, America/New_York。

imsi

可选

String(64)

Body

NB-IoT终端的IMSI。

ip

可选

String(128)

Body

设备的IP地址。

isSecure

可选

Boolean

body

指定设备是否为安全设备,默认值为false。在NB-IoT场景下,注册的设备为加密设备时,isSecure要设置为true。

  • true:安全设备
  • false:非安全设备

psk

可选

String(8~32)

body

psk参数,取值范围是a-f、A-F、0-9组成的字符串。

tags

可选

List<Tag2>

Body

设备的标签信息。

CustomField:

参数

必选/可选

类型

位置

描述

fieldName

可选

String(256)

Body

字段名字。

fieldType

可选

String(256)

Body

字段类型。

fieldValue

可选

Object

Body

字段值。

DeviceConfigDTO:

参数

必选/可选

字段类型

描述

dataConfig

可选

DataConfigDTO

数据配置信息。

DataConfigDTO:

参数

必选/可选

字段类型

描述

dataAgingTime

可选

Integer[0,90]

数据老化时长,取值范围:0-90,单位:天。

Tag2:

参数

必选/可选

类型

位置

描述

tagName

必选

String(1-128)

body

标签名称。

tagValue

必选

String(1-1024)

body

标签值。

tagType

可选

Integer

body

标签类型。

响应参数

Status Code: 204 No Content

请求示例

PUT https://{host}:{port}/iocm/app/dm/v1.4.0/devices/{deviceId}?appId={appId}
Content-Type: application/json
app_key: ******
Authorization: Bearer ******

{
  "name": "****",
  "endUser": "****",
  "mute": "****",
  "deviceConfig": {
    "dataConfig": {
      "dataAgingTime": 30
    }
  }
}

正常响应示例

Status Code: 204 No Content

错误码

Http状态码

错误码

错误描述

说明

200

100203

The application is not existed.

应用不存在。

处理建议:

  • 请检查HTTP请求头域中携带的appId是否有误。
  • 请检查请求路径(url)中传入的appId是否有误。

400

100022

The input is invalid.

输入参数无效。

处理建议:请检查接口调用请求中携带参数的合法性。

400

100440

The isSecure is invalid.

isSecure参数值有误。

400

50400

The input is invalid.

输入参数无效。

处理建议:请检查接口调用请求中携带参数的合法性。

403

100203

The application is not existed.

应用不存在。

处理建议:

  • 请检查HTTP请求头域中携带的appId是否有误。
  • 请检查请求路径(url)中传入的appId是否有误。

403

100217

The application hasn't been authorized.

应用未被授权。

处理建议:若非应用授权场景,请确认请求参数中的appId为空。

403

1010009

app throttle exceed.

应用调用接口过于频繁,超过流控值(默认值是100次/60s)。

处理建议:联系物联网平台维护人员调大流控阈值或者控制接口的调用频率。

403

1010005

Invalid access token or appId.

错误的token信息。

处理建议:请检查接口请求中所携带的accessToken是否有误。

403

500004

The amount of frozen devices has reached the limit.

被冻结设备已达到上限。

404

100403

The device is not existed.

设备不存在。

处理建议:物联网平台未找到deviceId对应的设备,请检查deviceId是否有误。

404

100418

The deviceData is not existed.

设备信息不存在。

处理建议:

  • 请求参数中携带的deviceId错误。请确认该deviceId是否属于该appId或者deviceId是否写错。
  • Header中携带的appId有误,请确认该appId下是否有该deviceId。
  • 如果URL中携带了可选参数appId,请检查该appId是否有误。

500

100203

The application is not existed.

应用不存在。

处理建议:

  • 请检查HTTP请求头域中携带的appId是否有误。
  • 请检查请求路径(url)中传入的appId是否有误。

500

100441

The amount of nonSecure device has reached the limit.

非安全设备数量已达到上限。

500

50252

Internal server error.

服务器运行内部错误。

处理建议:物联网平台内部错误,请联系物联网平台维护人员处理。

相关使用指南

设备监控

分享:

    相关文档

    相关产品

关闭导读