文档首页> 云数据库 GaussDB(for MySQL)> API参考> API（推荐）> 备份管理> 查询可恢复时间段
更新时间：2023-10-23 GMT+08:00
在线调试
CLI示例
查看PDF

查询可恢复时间段

功能介绍

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

URI

GET /v3/{project_id}/instances/{instance_id}/restore-time

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

instance_id

是

String

租户在某一project下的实例ID。
表2 Query参数

参数

是否必选

参数类型

描述

date

否

String

所需查询的日期，为yyyy-mm-dd字符串格式，时区为UTC。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。默认en-us。

取值范围：

  • en-us
  • zh-cn

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

restore_times

Array of RestoreTimeInfo objects

可恢复时间段列表。
表5 RestoreTimeInfo

参数

参数类型

描述

start_time

Integer

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

end_time

Integer

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

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询实例在2023-01-31的可恢复时间段。

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/restore-time?date=2023-01-31

响应示例

状态码： 200

Success.

{
  "restore_times" : [ {
    "start_time" : 1675149246000,
    "end_time" : 1675094400000
  } ]
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 备份管理