Querying Authorized Users of a Specified Database

Function

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

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 accounts of read replicas cannot be queried.

URI

URI format
GET /v3/{project_id}/instances/{instance_id}/database/db_user?db-name={db-name}&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
db-name	Yes	Definition Specifies the database name. Constraints N/A Range You can obtain the value of this parameter from name in Table 3 by calling the API for querying databases. Default Value N/A
page	Yes	Definition Specifies the page number. The value starts from 1. Constraints N/A Range N/A Default Value N/A
limit	Yes	Definition Specifies the 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/database/db_user?db-name=rds&page=1&limit=10

Response

Normal response

**Table 2** Parameters
Parameter	Type	Description
users	Array of objects	Definition Each element in the list indicates a database account. For details, see Table 3.
total_count	Integer	Definition Indicates the total number of database users. Range N/A

**Table 3** users element structure description
Parameter	Type	Description
name	String	Definition Account 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": "rds",
            "readonly": false
        },
        {
            "name": "rds001",
            "readonly": false
        }
    ],
    "total_count": 2
}