All Products
Search

This Product

    ApsaraDB RDS:ResetAccountPassword

    Document Center

    ApsaraDB RDS:ResetAccountPassword

    Last Updated:May 16, 2023

    You can call the ResetAccountPassword operation to reset the password of an account on an instance.

    Operation Description

    Before you call this operation, make sure that the instance is in the Running state.

    NoteIf the instance runs SQL Server 2017 on RDS Cluster Edition or runs PostgreSQL, you cannot call this operation to reset the passwords of accounts that are created by using SQL statements.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    rds:ResetAccountPasswordWRITE
    • RDS
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

    The ID of the instance.

    		rm-uf6wjk5xxxxxxx
    AccountNamestringYes

    The username of the account.

    		test1
    AccountPasswordstringYes

    The new password.

    Note

    • The value must be 8 to 32 characters in length.

    • The value must contain at least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters.

    • The following special characters are supported: ! @ # $ & % ^ * ( ) _ + - =

    		Test123456

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		D4D4BE8A-DD46-440A-BFCD-EE31DA81C9DD

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "D4D4BE8A-DD46-440A-BFCD-EE31DA81C9DD"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400Account.UpdateErrorUpdate Account failed, please check your input valueFailed to update the account. Check the specified parameters or the parameter policy configuration.
    400Database.ConnectErrorDatabase connect error. please check instance status and database processlistA database connection error occurred. Check the instance state and the database connection pool.
    400GdnRole.NotSupportSpecified gdn role is not support.-
    400InvalidAccountPassword.FormatSpecified account password is not valid.The password of the account is invalid. Specify a valid password.
    400IncorrectAccountStatusCurrent account status does not support this operation.-
    403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.The operation failed. The RDS instance is not in a ready state.
    403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.-
    403IncorrectAccountTypeCurrent account type does not support this operation.This operation is not supported for the current account type. Check the account type.
    403IncorrectDBInstanceCharacterTypeCurrent DB Instance character_type does not support this operation.This operation is not supported for the character type of the current instance.
    403IncorrectAccountPrivilegeTypethe current account privilege type does not support this operation.The permission type of the current account does not support this operation.
    404InvalidDBInstanceName.NotFoundThe database instance does not exist.The name of the RDS instance cannot be found. Check the name of the RDS instance.
    404IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.The operation failed. The RDS instance is locked.
    404InvalidAccountName.NotFoundSpecified account name does not exist.-

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2022-10-28The error codes of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
      Added Error Codes: 403
      Added Error Codes: 404
    2022-06-23API Description Update,The error codes of the API operation change.
    Change itemChange content
    API DescriptionAPI Description Update
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400