ResetDBInstancePassword

Last updated: 2021-04-13 15:35:09

1. API Description

Domain name for API request: mongodb.tencentcloudapi.com.

This API is used to modify instance password.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: mongodb.ap-shanghai-fsi.tencentcloudapi.com

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: ResetDBInstancePassword.
Version Yes String Common parameter. The value used for this API: 2019-07-25.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID
UserName Yes String Instance account name
Password Yes String New password

3. Output Parameters

Parameter Name Type Description
AsyncRequestId String Async request ID, which is used to query the running status of the process.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying the instance password

Input Example

https://mongodb.tencentcloudapi.com/?Action=ResetDBInstancePassword
&InstanceId=cmgo-7pjedvz7
&UserName=rwuser
&Password=111111
&<Common request parameters>

Output Example

{
  "Response": {
    "AsyncRequestId": "4769",
    "RequestId": "e600a8d0-9014-11ea-84c1-01cccde830c6"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error
InvalidParameter Parameter error
InvalidParameter.PermissionDenied The current subaccount has no permission to perform this operation.
InvalidParameterValue.IllegalInstanceStatus Invalid instance status
InvalidParameterValue.LockFailed Instance lock failed.
InvalidParameterValue.NotFoundInstance The instance was not found.
InvalidParameterValue.PasswordRuleFailed The password is non-compliant.
InvalidParameterValue.StatusAbnormal The instance is in a status where operations are not allowed.
InvalidParameterValue.UserNotFound The user account does not exist.