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

Importing a Data File to an Existing Instance

Function

This API is used to import data to an existing instance.

Constraints

This API supports the following instance:

GeminiDB Redis

Data cannot be imported to an instance that is being restored.

Currently, only RDB files can be imported.

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

URI

POST /v3/{project_id}/redis/instances/{instance_id}/recovery

**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
recovery_info	No	RecoveryInfo object	Definition Information about the OBS where a backup file is stored Constraints N/A

**Table 4** RecoveryInfo
Parameter	Mandatory	Type	Description
bucket_name	Yes	String	Definition OBS bucket where a backup file is stored Constraints N/A Range N/A Default Value N/A
files	Yes	Array of strings	Definition Backup file name Constraints N/A

Response Parameters

Status code: 202

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

Example Requests

Restoring data using an RDB backup

POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/redis/instances/a4d8ea2584e047439a667703c0684119in06/recovery

{  
  "recovery_info" : 
 { 
    "bucket_name" : "test-bucket",  
    "files" : [ "file1.rdb", "file2.rdb" ]  
  } 
}

Example Responses

Status code: 202

Success

{    
  "job_id" : "f85104b5-4a9c-4e0f-9505-fc5409d8f7ae"  
}

Status Codes

See Status Codes.

Error Codes

See Error Codes.

Parent topic: Backups and Restorations