Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Managing Databases and Accounts/ Obtaining All Databases in an Instance
Updated on 2025-11-27 GMT+08:00
View PDF
Share

Obtaining All Databases in an Instance

Function

This API is used to obtain the database list for a GeminiDB Redis instance.

Constraints

  • Only the GeminiDB Redis API is supported.
  • This operation cannot be performed when the instance is in any of the following states: creating, changing specifications, changing database port, frozen, or abnormal.
  • Only databases of instances that contain data are returned.

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 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

    gaussdbfornosql:instance:listDatabase

    List

    instance *
    • g:ResourceTag/<tag-key>
    • g:EnterpriseProjectId
    • nosql:database:list
    • nosql:backup:list

    -

URI

GET /v3/{project_id}/redis/instances/{instance_id}/databases

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Index offset

  • The query starts from the next piece of data indexed by this parameter. The value is 0 by default.
  • The value must be a positive integer.

limit

No

Integer

Maximum records to be queried

  • The value ranges from 1 to 100.
  • If this parameter is not transferred, the first 100 records are queried by default.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

databases

Array of strings

All databases in the GeminiDB Redis instance.

total_count

Integer

Total number of records.

Example Request

URI example 
GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/
/v3/375d8d8fad1f43039e23d3b6c0f60a19/redis/instances/9136fd2a9fcd405ea4674276ce36dae8in12/databases

Example Response

Status code: 200

Success

{ 
  "databases" : [ "1", "2", "3" ], 
  "total_count" : 3 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.