更新时间:2024-05-31 GMT+08:00

重置网桥密钥

功能介绍

应用服务器可调用此接口在物联网平台上重置网桥密钥。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v5/iot/{project_id}/bridges/{bridge_id}/reset-secret

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

bridge_id

String

网桥ID。取值范围:长度不超过36,只允许字母、数字、_-字符的组合。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

Instance-Id

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

force_disconnect

Boolean

是否强制断开网桥的连接,当前仅限长连接。

缺省值:false

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

bridge_id

String

网桥ID

secret

String

网桥密钥。

请求示例

POST https://{endpoint}/v5/iot/{project_id}/bridges/{bridge_id}/reset-secret

{
  "force_disconnect" : false
}

响应示例

状态码: 200

OK

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

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码