查询实例可恢复的时间段
功能介绍
查询实例可恢复的时间段。
接口约束
该接口支持如下数据库实例:
- GeminiDB Cassandra
- GeminiDB Influx
该接口不支持GeminiDB Influx单节点实例。
使用该接口前,需确保全量备份、增量备份和自动备份策略已开启。增量备份您可以联系客服申请开通,增量备份开通后,等下次自动备份时才会开启。
该接口目前仅支持查询实例可恢复的时间点,所以“start_time”和“end_time”的参数取值是相同的。
URI
GET /v3/{project_id}/instances/{instance_id}/backups/restorable-time-periods
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 用户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
instance_id |
是 |
String |
参数解释: 实例Id,可以调用7.3.3 查询实例列表和详情接口获取。如果未申请实例,可以调用7.3.1 创建实例接口创建。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
start_time |
否 |
String |
参数解释: 查询的可恢复时间段的开始时间点,为yyyy-mm-ddThh:mm:ssZ字符串格式,T指某个时间的开始,Z指时区偏移量。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 当前查询时间的前一天。 |
|
end_time |
否 |
String |
参数解释: 查询的可恢复时间段的结束时间点,为yyyy-mm-ddThh:mm:ssZ字符串格式,T指某个时间的开始,Z指时区偏移量。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 默认值为当前查询时间。 |
|
offset |
否 |
Integer |
参数解释: 偏移量,表示查询该偏移量后面的记录。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 0。 |
|
limit |
否 |
Integer |
参数解释: 查询返回记录的数量上限值。 约束限制: 不涉及。 取值范围: 0~1000。 默认取值: 1000。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码: 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_count |
Integer |
参数解释: 实例可恢复时间段总数。 取值范围: 不涉及。 |
|
restorable_time_periods |
Array of restorableTime objects |
参数解释: 实例可恢复的时间段。 取值范围: 不涉及。 |
请求示例
- URI样例
GET https://gaussdb-nosql.ap-southeast-1.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
} ]
}
状态码
请参见状态码。
错误码
请参见错误码。