Resetting a Password
Function
This API is used to reset the password of a DCS instance.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/instances/{instance_id}/password/reset
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
instance_id |
Yes |
String |
Parameter description: Instance ID. It can be viewed on the instance details page on the DCS console. Constraints: N/A Value range: N/A Default value: N/A |
project_id |
Yes |
String |
Parameter description: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Value range: N/A Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
new_password |
No |
String |
Definition: New password. When no_password_access is set to false or not specified, the request must contain the password parameter. Constraints: The password contains 8 to 64 characters. Range: Contains at least three types of the following characters:
Default Value: N/A |
no_password_access |
No |
Boolean |
Parameter description: Whether to change the DCS instance to password-free. Constraints: N/A Value range:
Default value: false |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
retry_times_left |
String |
Parameter description: Number of remaining password attempts. Resetting the password does not involve password verification. This parameter is deprecated. The default return is 5. Value range: N/A |
lock_time |
String |
Parameter description: Lockout duration, in minutes. Resetting the password does not involve lockout. This parameter is deprecated. The default return is 0. Value range: N/A |
lock_time_left |
String |
Parameter description: Lockout remaining time, in minutes. Resetting the password does not involve lockout. This parameter is deprecated. The default return is 0. Value range: N/A |
code |
String |
Parameter description: Code of a password resetting result. Value range: 1: The password is reset successfully. |
message |
String |
Parameter description: Password resetting result. Value range: success |
ext_message |
String |
Parameter description: Password resetting error. This parameter is null if the password is reset successfully. Value range: N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error message. Value range: N/A. |
error_code |
String |
Parameter description: Error code. Value range: For details, see Error Codes. |
error_ext_msg |
String |
Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error message. Value range: N/A. |
error_code |
String |
Parameter description: Error code. Value range: For details, see Error Codes. |
error_ext_msg |
String |
Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A. |
Example Requests
Resetting the password of the DCS instance by entering a new password
POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/password/reset { "new_password" : "xxxxxx", "no_password_access" : false }
Example Responses
Status code: 200
Definition:
The password of the DCS instance is reset.
{ "lock_time" : "0", "lock_time_left" : "0", "retry_times_left" : "5", "code" : "1", "message" : "success", "ext_message" : null }
Status code: 400
Invalid request.
{ "error_code" : "DCS.4839", "error_msg" : "is not support reset instance password." }
SDK Sample Code
The SDK sample code is as follows.
Resetting the password of the DCS instance by entering a new password
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dcs.v2.region.DcsRegion; import com.huaweicloud.sdk.dcs.v2.*; import com.huaweicloud.sdk.dcs.v2.model.*; public class ResetPasswordSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DcsClient client = DcsClient.newBuilder() .withCredential(auth) .withRegion(DcsRegion.valueOf("<YOUR REGION>")) .build(); ResetPasswordRequest request = new ResetPasswordRequest(); request.withInstanceId("{instance_id}"); ResetInstancePasswordBody body = new ResetInstancePasswordBody(); body.withNoPasswordAccess(false); body.withNewPassword("xxxxxx"); request.withBody(body); try { ResetPasswordResponse response = client.resetPassword(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Resetting the password of the DCS instance by entering a new password
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdcs.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DcsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ResetPasswordRequest() request.instance_id = "{instance_id}" request.body = ResetInstancePasswordBody( no_password_access=False, new_password="xxxxxx" ) response = client.reset_password(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Resetting the password of the DCS instance by entering a new password
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dcs.NewDcsClient( dcs.DcsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ResetPasswordRequest{} request.InstanceId = "{instance_id}" noPasswordAccessResetInstancePasswordBody:= false newPasswordResetInstancePasswordBody:= "xxxxxx" request.Body = &model.ResetInstancePasswordBody{ NoPasswordAccess: &noPasswordAccessResetInstancePasswordBody, NewPassword: &newPasswordResetInstancePasswordBody, } response, err := client.ResetPassword(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Definition: The password of the DCS instance is reset. |
400 |
Invalid request. |
500 |
Internal service 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