Reset the Bridge Secret
Function
This API is used by an application to reset the bridge secret on the IoT platform.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
iotda:bridge:reset
Write
-
g:EnterpriseProjectId
-
-
URI
POST /v5/iot/{project_id}/bridges/{bridge_id}/reset-secret
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Parameter description: project ID. For details, see Obtaining a Project ID. |
|
bridge_id |
Yes |
String |
Bridge ID. Value: The value can contain a maximum of 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
Instance-Id |
No |
String |
Parameter description: instance ID. Unique identifier of each instance in the physical multi-tenant scenario. Mandatory for professional editions and recommended in other cases. Log in to the IoTDA console and choose Overview in the navigation pane to view the instance ID. For details, see Viewing Instance Details. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
force_disconnect |
No |
Boolean |
Whether to forcibly disconnect a bridge. Only persistent connections are supported. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
bridge_id |
String |
Bridge ID. |
|
secret |
String |
Bridge secret. |
Example Requests
POST https://{endpoint}/v5/iot/{project_id}/bridges/{bridge_id}/reset-secret
{
"force_disconnect" : false
}
Example Responses
Status code: 200
OK
{
"bridge_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f",
"secret" : "3b935a250c50dc2c6d481d048cefdc3c"
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server Error |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot