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

Updated on 2025-12-04 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.

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

URI

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

**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 N/A Default Value N/A
instance_id	Yes	String	Definition Instance ID 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 To obtain this value, call the IAM API for obtaining a user token. Constraints N/A Range N/A Default Value N/A

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

Response Parameters

Status code: 200

Successful response

Example Requests

Enabling or disabling instance data export

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