文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 实例管理/ 开启/关闭实例数据导出
更新时间：2024-12-02 GMT+08:00
查看PDF
分享

开启/关闭实例数据导出

功能介绍

开启/关闭实例数据导出。

当前支持将InfluxDB数据转为parquet格式文件然后上传到指定的OBS桶中。

接口约束

支持GeminiDB InfluxDB性能版数据库实例。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。获取方法请参见获取项目ID。

instance_id

是

String

实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。
表3 请求Body参数

参数

是否必选

参数类型

描述

bucket_name

是

String

OBS桶名。

action

是

String

开启/关闭实例数据导出。

响应参数

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

开启/关闭实例数据导出。

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

响应示例

无。

状态码

请参见状态码。

错误码

请参见状态码。

父主题： 实例管理

相关文档