Updated on 2026-09-22 GMT+08:00

Performing Operations on GeminiDB Instances

Function

This API is used to perform operations on GeminiDB instances.

Constraints

This API supports GeminiDB Redis instances with classic storage.

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:operateDatabase	Write	instance *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	nosql:instance:operateDatabase	-

URI

PUT /v3/{project_id}/instances/{instance_id}/databases

**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 contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID. To obtain the value, call the Querying Instances and Details API. If no instance is available, call the Creating an Instance API to create one. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
action	Yes	String	Definition Operation on an instance. Constraints N/A Range flush: Clear data. Default Value N/A
db_id	No	Integer	Definition ID of the database to be cleared. To obtain the value, call the Obtaining All Databases in an Instance API. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 202

**Table 4** Response body parameters
Parameter	Type	Description
job_id	String	Definition Task ID. Range N/A

Example Requests

Clearing data in a specified database

PUT https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/e73893ef73754465a8bd2e0857bbf13ein12/databases 
 { 
   "action" : "flush", 
   "db_id" : 1 
 }

Clearing all data

PUT https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/e73893ef73754465a8bd2e0857bbf13ein12/databases 
 { 
   "action" : "flush" 
 }

Example Responses

Status code: 202

Accepted.

{ 
  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890" 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Managing Databases and Accounts