Resetting the admin Password of a CBH Instance
Function
This API is used to reset the password of user admin, which is used for logging in to the CBH instance over a web client.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{project_id}/cbs/instance/password
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID, which uniquely identifies a project. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. For details, see Obtaining a User Token. Constraints N/A Range String type. The value can contain 1 to 28,000 characters. Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| new_password | Yes | String | The new password of user admin can contain 8 to 32 characters, including letters, digits, and special characters. |
| server_id | Yes | String | CBH instance ID, in UUID format. |
Response Parameters
Status code: 200
None
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_description | String | Incorrect request parameters. |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_description | String | Token verification failed. |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_description | String | Permissions required. |
Status code: 404
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_description | String | Not CBH instances found. |
Example Requests
{
"new_password" : "Xxxxxxxxx1!",
"server_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
} Example Responses
None
Status Codes
| Status Code | Description |
|---|---|
| 200 | Reset Instance Password Success |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank 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