文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 管理数据库和账号/ 操作GeminiDB实例数据库 - PerformingOperationsonGeminiDBInstances
更新时间：2025-11-27 GMT+08:00
查看PDF
分享

操作GeminiDB实例数据库 - PerformingOperationsonGeminiDBInstances

功能介绍

操作GeminiDB实例数据库。

接口约束

该接口支持GeminiDB Redis数据库实例。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbfornosql:instance:operateDatabase

    Write

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

    nosql:instance:operateDatabase

    -

URI

PUT /v3/{project_id}/instances/{instance_id}/databases

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。
表3 请求Body参数

参数

是否必选

参数类型

描述

action

是

String

对实例的操作。

Flush：清理数据。

db_id

否

Integer

指定需要清理的DB_ID，当action为Flush时，才会生效。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

job_id

String

任务ID。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

  • 清除指定DB的数据 
    PUT https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/e73893ef73754465a8bd2e0857bbf13ein12/databases 
 { 
   "action" : "flush", 
   "db_id" : 1 
 }
  • 清除所有数据 
    PUT https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/e73893ef73754465a8bd2e0857bbf13ein12/databases 
 { 
   "action" : "flush" 
 }

响应示例

状态码： 200

Accepted.

{ 
  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890" 
}

状态码

请参见状态码。

错误码

请参见错误码。