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

开启/关闭实例数据导出 - EnablingorDisablingInstanceDataExport

功能介绍

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

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

接口约束

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbfornosql:instance:operateDataDump

    write

    instance *
    • g:ResourceTag/<tag-key>
    • g:EnterpriseProjectId

    nosql:instance:operateDataDump

    -

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。

通过调用IAM服务获取用户Token接口获取。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

bucket_name

是

String

参数解释：

OBS桶名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

action

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

Success.

请求示例

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

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

响应示例

无。

状态码

请参见状态码。

错误码

请参见状态码。

父主题： 实例管理