Help Center/ Document Database Service/ API Reference (Ally Region)/ APIs V3.0 (Recommended)/ Managing Databases and Users/ Checking the Password for Logging In to a Database
Updated on 2026-01-08 GMT+08:00
View PDF
Share

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

Table 1 Path parameters

Name

Type

IN

Mandatory

Description

project_id

string

path

Yes

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

instance_id

string

path

Yes

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.

Request Parameters

Table 2 Request header parameters

Parameter

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

User token
Table 3 Parameter description

Parameter

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".
  • Request example 
    {
"user_name": "rwuser",
"user_pwd": "******"
}

Response Parameters

  • Example response 
    {}

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.