文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 备份与恢复/ 查询实例可恢复的时间段
更新时间：2023-11-21 GMT+08:00
查看PDF
分享

查询实例可恢复的时间段

功能介绍

查询实例可恢复的时间段。

接口约束

该接口支持如下数据库实例：

  • GeminiDB Cassandra
  • GeminiDB Influx

该接口不支持GeminiDB Influx单节点实例。

使用该接口前，需确保全量备份、增量备份和自动备份策略已开启。增量备份您可以联系客服申请开通，增量备份开通后，等下次自动备份时才会开启。

该接口目前仅支持查询实例可恢复的时间点，所以“start_time”和“end_time”的参数取值是相同的。

调试

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

URI

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/restorable-time-periods

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

实例Id，可以调用5.3.3 查询实例列表和详情接口获取。如果未申请实例，可以调用5.3.1 创建实例接口创建。
表2 Query参数

参数

是否必选

参数类型

描述

start_time

否

String

查询的可恢复时间段的开始时间点，为yyyy-mm-ddThh:mm:ssZ字符串格式，T指某个时间的开始，Z指时区偏移量。

例如北京时间偏移显示为+0800。默认值为当前查询时间的前一天。

end_time

否

String

查询的可恢复时间段的结束时间点，为yyyy-mm-ddThh:mm:ssZ字符串格式，T指某个时间的开始，Z指时区偏移量。

例如北京时间偏移显示为+0800。默认值为当前查询时间。

offset

否

Integer

偏移量，表示查询该偏移量后面的记录，默认值为0。

limit

否

Integer

查询返回记录的数量上限值，取值范围为0~1000，默认值为1000。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户token。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

实例可恢复时间段总数。

restorable_time_periods

Array of restorableTime objects

实例可恢复的时间段。
表5 restorableTime

参数

参数类型

描述

start_time

Long

可恢复时间段的开始时间点，UNIX时间戳格式，单位是毫秒，时区是UTC。

end_time

Long

可恢复时间段的结束时间点， UNIX时间戳格式，单位是毫秒，时区是UTC。

请求示例

  • URI样例 
    GET https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/a4d8ea2584e047439a667703c0684119in06/backups/restorable-time-periods?start_time=2022-06-01T18:50:20+0800&end_time=2022-06-01T19:50:20+0800&offset=0&limit=1000

响应示例

状态码： 200

Success

{
  "total_count" : 1,
  "restorable_time_periods" : [ {
    "start_time" : 1607731200000,
    "end_time" : 1607731200000
  } ]
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 备份与恢复

相关文档