Querying Database Users

Function

This API is used to query database users of a specified DB instance.

Before calling this API, learn how to authenticate it.
Before calling this API, learn about the request header parameters.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
rds:databaseUser:list	list	instance	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:databaseUser:list

list

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

Constraints

This operation cannot be performed when the DB instance is in the abnormal or frozen state.
The database user list of read replicas cannot be queried.

URI

URI format
GET /v3/{project_id}/instances/{instance_id}/db_user/detail?page={page}&limit={limit}

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Description
project_id	Yes	Definition Project ID of a tenant in a region. Constraints The value cannot be empty. Range To obtain the value, see Obtaining a Project ID. Default Value N/A
instance_id	Yes	Definition Instance ID. Constraints The value cannot be empty. Range You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances. Default Value N/A
page	Yes	Definition Page number. The value starts from 1. Constraints N/A Range N/A Default Value N/A
limit	Yes	Definition Number of records on each page. Constraints N/A Range [1, 100] Default Value N/A

Request

Request parameters
None

URI example
GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/db_user/detail?page=1&limit=10

Response

Normal response

**Table 2** Parameters
Parameter	Type	Description
users	Array of objects	Definition Database account information. For details, see Table 3.
total_count	Integer	Definition Total number of database accounts. Range N/A

**Table 3** users element structure description
Parameter	Type	Description
name	String	Definition Account name. Range N/A
comment	String	Definition Account remarks. This parameter is only available to RDS for MySQL 8.0.25 and later versions. Range N/A
databases	Array of objects	Definition Databases authorized to the account. For details, see Table 4.
hosts	Array of strings	Definition Hosts configured for the account. Range If the IP address is set to %, all IP addresses are allowed to access your instance. If the IP address is set to 10.10.10.%, all IP addresses in the subnet 10.10.10.X are allowed to access your instance. Multiple IP addresses can be added.

**Table 4** databases element structure description
Parameter	Type	Description
name	String	Definition Database name. Range N/A
readonly	Boolean	Definition Whether the permission is read-only. Range true: read-only false: read/write

Example normal response

{
    "users": [
        {
            "name": "aaa",
            "comment": "user comment",
            "databases": [
                {
                    "name": "db1",
                    "readonly": false
                }
            ],
            "hosts": [
                "10.%"
            ]
        }
    ],
    "total_count": 1
}