更新时间:2025-07-29 GMT+08:00

查询增量备份列表

功能介绍

查询增量备份列表。

URI

GET /v3/{project_id}/instances/{instance_id}/incremental-backups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

instance_id

String

参数解释

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

String

参数解释

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制

必须为整数,不能为负数。

取值范围

≥0。

默认取值

0。

limit

String

参数解释

查询记录数。

约束限制

必须为整数,不能为负数。

取值范围

10、20、50。

默认取值

10。

begin_time

String

参数解释

查询开始时间。

约束限制

“begin_time”有值时,“end_time”必选。

取值范围

格式为“yyyy-mm-ddThh:mm:ssZ”。

其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。

默认取值

不涉及。

end_time

String

参数解释

查询结束时间。

约束限制

“end_time”有值时,“begin_time”必选。

取值范围

格式为“yyyy-mm-ddThh:mm:ssZ”,且大于查询开始时间。

其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。

默认取值

不涉及。

请求参数

表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参数

参数

参数类型

描述

backups

Array of IncrementalBackups objects

参数解释

备份信息。

total_count

Long

参数解释

备份文件的总数。

取值范围

不涉及。

表5 IncrementalBackups

参数

参数类型

描述

id

String

参数解释

备份ID。

取值范围

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

name

String

参数解释

备份名称。

取值范围

最小为4个字符,最大为64个字符且不超过64个字节(注意:一个中文字符占用3个字节),必须以字母或中文开头,区分大小写,可以包含字母、数字、中划线、下划线或中文,不能包含其他特殊字符。

begin_time

String

参数解释

备份开始时间。

取值范围

格式为“yyyy-mm-ddThh:mm:ssZ”。

其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。

end_time

String

参数解释

备份结束时间。

取值范围

格式为“yyyy-mm-ddThh:mm:ssZ”。

其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。

size

Number

参数解释

备份大小,(单位:KB)。

取值范围

不涉及。

instance_id

String

参数解释

实例ID。

取值范围

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

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询时间段内(2022-07-06~2022-07-16)的增量备份列表。

GET https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/61a4ea66210545909d74a05c27a7179ein07/incremental-backups?offset=0&limit=10&begin_time=2022-07-06T10:41:14+0800&end_time=2022-07-16T10:41:14+0800

响应示例

状态码: 200

Success.

{
  "backups" : [ {
    "id" : "f0d2aea28d26t4848b8c84ed3fea1822fbr07",
    "name" : "TaurusDB--20230728181555006",
    "begin_time" : "2022-07-07T12:41:14+0800",
    "end_time" : "2022-07-08T12:45:14+0800",
    "size" : 0.109375,
    "instance_id" : "61a4ea66210545909d74a05c27a7179ein07"
  } ],
  "total_count" : 1
}

状态码

请参见状态码

错误码

请参见错误码