Help Center/ Data Admin Service/ API Reference/ APIs/ Intelligent O&M/ Obtaining the Database Name List
Updated on 2026-08-25 GMT+08:00

Obtaining the Database Name List

Function

This API is used to obtain the database name list.

Authorization Information

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

  • If you are using role/policy-based authorization, see the required permissions in Permissions Policies and Supported Actions.
  • 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

    das::showCloudDBAInfo

    Read

    -

    -

    -

    -

URI

GET /v3/{project_id}/instances/{instance_id}/databases/get-name-list

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are supported.

Default Value

N/A

instance_id

Yes

String

Definition

Unique ID of an instance

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are supported.

Default Value

N/A

Request Parameters

Table 2 Query parameters

Parameter

Mandatory

Type

Description

engine_type

Yes

String

Definition

DB engine type

Constraints

N/A

Range

postgresql

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

data

List of Objects

Definition

Database list

Range

Array length: 0 to 200 characters

total

Integer

Definition

Total number

Range

[0,10000]

Example Requests

GET https://das.cn-north-1.myhuaweicloud.com/v3/052041494800d57c2f02c00275b4c247/instances/1b4af3014b794e6482e8f1cc4cbaaad3in03/databases/get-name-list?engine_type=postgresql 
 

Example Responses

Status code: 200

Success.

{
    "data": [
        {
            "name": "postgres",
            "owner": "rdsAdmin",
            "comment": "default administrative connection database",
            "character_set": "UTF8",
            "collate_set": "C"
        },
        {
            "name": "test_db",
            "owner": "root",
            "character_set": "UTF8",
            "collate_set": "C"
        }
    ],
    "total": 2
}

Status Codes

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Codes

See Error Codes.