文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 备份管理/ 查询可恢复时间段- ShowBackupRestoreTime
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询可恢复时间段 - ShowBackupRestoreTime

功能介绍

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

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:backup:getRestoreTime

    Read

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>
    • gaussdb:instance:list
    • gaussdb:backup:list

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID，此参数是实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，后缀为in07，长度为36个字符。

默认取值：

不涉及。
表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

  • zh-cn

默认取值：

en-us。

响应参数

状态码： 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
  } ]
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 备份管理