Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Enabling or Disabling Instance Data Export

Updated on 2025-09-16 GMT+08:00

View PDF

Enabling or Disabling Instance Data Export

Function

This API is used to enable or disable instance data export.

Currently, GeminiDB Influx instance data can be converted into a .parquet file and then uploaded to a specified OBS bucket.

Constraints

This API can be used only on performance-enhanced GeminiDB Influx instances.

URI

PUT /v3/{project_id}/instances/{instance_id}/data-dump

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation: Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints: N/A Values: N/A Default value: N/A
instance_id	Yes	String	Explanation: Instance ID Constraints: N/A Values: N/A Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Explanation: User token To obtain this value, call the IAM API for obtaining a user token. Constraints: N/A Values: N/A Default value: N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
bucket_name	Yes	String	Explanation: OBS bucket name Constraints: N/A Values: N/A Default value: N/A
action	Yes	String	Explanation: Enables or disables instance data export. Constraints: N/A Values: N/A Default value: N/A

Response Parameters

Status code: 200

Successful request

Example Request

Enabling or disabling instance data export

PUT https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/0a9a2be86bdf493981d17626ad2f8668in13/data-dump 
 
{ 
  "bucket_name" : "influxdb-obs", 
  "action" : "open" 
}