Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Enabling or Disabling Instance Data Export
Updated on 2024-12-31 GMT+08:00

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 https://{Endpoint}/v3/{project_id}/instances/{instance_id}/data-dump

Table 1 URI 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

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

bucket_name

Yes

String

OBS bucket name

action

Yes

String

Enables or disables instance data export.

Response Parameters

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Request

Enabling or disabling instance data export

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

Example Response

None

Status Codes

See Status Codes.

Error Codes

See Status Codes.