重置设备指纹 - ResetFingerprint
功能介绍
应用服务器可调用此接口重置设备指纹。携带指定设备指纹时将之重置为指定值;不携带时将之置空,后续设备第一次接入时,该设备指纹的值将设置为第一次接入时的证书指纹。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
iotda:devices:resetFingerprint
Write
app *
-
-
-
-
g:EnterpriseProjectId
URI
POST /v5/iot/{project_id}/devices/{device_id}/reset-fingerprint
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数说明:项目ID。获取方法请参见 获取项目ID。 |
| device_id | 是 | String | 参数说明:设备ID,用于唯一标识一个设备。在注册设备时直接指定,或者由物联网平台分配获得。 取值范围:长度不超过128,只允许字母、数字、下划线(_)、连接符(-)的组合。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Instance-Id | 否 | String | 参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考 查看实例详情。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| fingerprint | 否 | String | 参数说明:设备指纹。设置该字段时平台将设备指纹重置为指定值;不携带时将之置空,后续设备第一次接入时,该设备指纹的值将设置为第一次接入时的证书指纹。 取值范围:长度为40的十六进制字符串或者长度为64的十六进制字符串。 |
| force_disconnect | 否 | Boolean | 参数说明:是否强制断开设备的连接,当前仅限长连接。默认值false。 |
| fingerprint_type | 否 | String | 参数说明:重置设备证书指纹的的类型。 取值范围:
|
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| device_id | String | 设备ID,用于唯一标识一个设备。在注册设备时直接指定,或者由物联网平台分配获得。由物联网平台分配时,生成规则为"product_id" + "_" + "node_id"拼接而成。 |
| fingerprint | String | 设备指纹。 |
| fingerprint_type | String | 参数说明:重置设备证书指纹的的类型。 取值范围:
|
请求示例
重置设备指纹,新指纹为dc0f****f22f。
POST https://{endpoint}/v5/iot/{project_id}/devices/{device_id}/reset-fingerprint
{
"fingerprint" : "dc0f****f22f"
} 响应示例
状态码:200
OK
{
"device_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f",
"fingerprint" : "dc0f****f22f",
"fingerprint_type" : "PRIMARY"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |
错误码
请参见错误码。