Updated on 2025-08-22 GMT+08:00

Checking the Password for Logging In to a Database

Description

This API is used to check the password for logging in to a database.

Restrictions

This operation cannot be performed on frozen or abnormal instances.

URI

  • URI format

    POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/check-password

  • URI example

    https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/check-password

Table 1 Request parameters

Name

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

Explanation:

User token obtained from IAM. For details, see Authentication.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

project_id

string

path

Yes

Explanation:

Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

instance_id

string

path

Yes

Explanation:

Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Request Parameters

  • Parameter description
    Table 2 Parameter description

    Name

    Type

    Mandatory

    Description

    user_name

    String

    No

    The database username. The default value is "rwuser".

    The value must be 1 to 64 characters and can contain only letters (from A to Z or from a to z), digits (from 0 to 9), hyphens (-), and periods (.).

    user_pwd

    String

    Yes

    The database password.

    The value must be 8 to 32 characters in length and contain uppercase letters (A to Z), lowercase letters (a to z), digits (0 to 9), and special characters, such as ~!@#%^*-_=+?

    db_name

    String

    No

    The database name. The default value is "admin".

Example Request

Checking the password for logging in to a database
{
"user_name": "rwuser",
"user_pwd": "******"
}

Response Parameters

  • Response example
    {}

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.