Help Center> IoT Device Access> API Reference> 应用侧API参考> 设备管理> 重置设备密钥
View PDF

重置设备密钥

接口说明

应用服务器可调用此接口重置设备密钥，携带指定密钥时平台将设备密钥重置为指定的密钥，不携带密钥时平台将自动生成一个新的随机密钥返回。

调试

您可以在API Explorer中直接运行调试该接口。

URI

请求方法

POST

URI

/v5/iot/{project_id}/devices/{device_id}/action

传输协议

HTTPS

请求参数

名称

必选/可选

类型

位置

说明

X-Auth-Token

必选

String

Header

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

Instance-Id

可选

String

Header

参数说明：实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。

project_id

必选

String

Path

参数说明：项目ID。获取方法请参见 获取项目ID。

device_id

必选

String

Path

参数说明：设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为"product_id" + "_" + "node_id"拼接而成。

取值范围：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。

action_id

必选

String

Query

参数说明：对设备执行的操作。

取值范围：

  • resetSecret: 重置密钥。注意：NB设备密钥由于协议特殊性，只支持十六进制密钥接入。

secret

可选

String

Body

参数说明：设备密钥，设置该字段时平台将设备密钥重置为指定值，若不设置则由平台自动生成。

取值范围：长度不低于8不超过32，只允许字母、数字、下划线（_）、连接符（-）的组合。

force_disconnect

可选

Boolean

Body

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

响应参数

名称

类型

说明

device_id

String

设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为"product_id" + "_" + "node_id"拼接而成。

secret

String

设备密钥。

请求示例

POST https://{Endpoint}/v5/iot/{project_id}/devices/{device_id}/action?action_id={action_id}
Content-Type: application/json
X-Auth-Token: ********
Instance-Id: ********

{
  "secret" : "3b935a250c50dc2c6d481d048cefdc3c",
  "force_disconnect" : false
}

响应示例

Status Code: 200 OK

Content-Type: application/json

{
  "device_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f",
  "secret" : "3b935a250c50dc2c6d481d048cefdc3c"
}

错误码

HTTP状态码

错误码

错误码英文描述

错误码中文描述

处理建议

403

IOTDA.000022

Operation not allowed. The user does not have the permission

该用户没有权限

请排查该用户是否有权限访问。

404

IOTDA.014000

The device does not exist.

设备不存在

请排查请求参数是否有误并确认是否有在平台注册该设备。
父主题： 设备管理