设备接入 IOTDA-重置设备密钥:请求参数

时间:2024-06-28 09:24:57

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数说明:用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证

Instance-Id

String

参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考查看实例详情

表4 请求Body参数

参数

是否必选

参数类型

描述

secret

String

参数说明:设备密钥,设置该字段时平台将设备密钥重置为指定值,若不设置则由平台自动生成。 取值范围:长度不低于8不超过32,只允许字母、数字、下划线(_)、连接符(-)的组合。

最小长度:8

最大长度:32

force_disconnect

Boolean

参数说明:是否强制断开设备的连接,当前仅限长连接。默认值false。

缺省值:false

secret_type

String

参数说明:重置设备密钥的的类型。 取值范围

  • PRIMARY:重置主密钥。设备密钥鉴权优先使用的密钥,当设备接入 物联网平台 时,平台将优先使用主密钥进行校验。

  • SECONDARY:重置辅密钥。设备的备用密钥,当主密钥校验不通过时,会启用辅密钥校验,辅密钥与主密钥有相同的效力;辅密钥对coap协议接入的设备不生效。

缺省值:PRIMARY

support.huaweicloud.com/api-iothub/iot_06_v5_0093.html