# 查询备份列表 - QueryingBackups #### 功能介绍 根据指定条件查询备份列表。 目前仅支持GeminiDB Cassandra查看数据备份的增量备份和差异备份文件大小和记录。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDBforNoSQL/doc?api=ShowAllInstancesBackups)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbfornosql:instance:listRestorableInstances | List | instance \* | - g:ResourceTag/\ - g:EnterpriseProjectId | nosql:instance:list | - | #### URI GET /v3/{project_id}/backups 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 是 | Integer | **参数解释：** 分页页码。 **约束限制：** 不涉及。 **取值范围：** 取值大于等于1。 **默认取值：** 不涉及。 | | limit | 是 | Integer | **参数解释：** 每页条数。 **约束限制：** 不涉及。 **取值范围：** 1\~100。 **默认取值：** 不涉及。 | | datastore_type | 否 | String | **参数解释：** 接口类型。 **约束限制：** 不涉及。 **取值范围：** - 取值为"cassandra"，表示查询GeminiDB Cassandra引擎。 - 取值为"mongodb"，表示GeminiDB Mongo查询引擎。 - 取值为"redis"，表示查询GeminiDB Redis引擎。 - 取值为"influxdb"，表示查询GeminiDB Influx引擎。 **默认取值：** 不传该参数时则查询所有的接口。 | | type | 否 | String | **参数解释：** 备份策略类型。 **约束限制：** 不涉及。 **取值范围：** - Instance：表示查询实例级备份。 - DatabaseTable：表示查询库表级备份，仅GeminiDB Cassandra支持。 **默认取值：** Instance。 | | instance_id | 否 | String | **参数解释：** 实例ID。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不传该参数则查询所有备份列表。 | | backup_id | 否 | String | **参数解释：** 备份文件ID。 获取方式请参见"[查询备份列表](https://support.huaweicloud.com/api-nosql/nosql_12_0011.html)"响应参数"backups"。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不传该参数则查询所有备份列表。 | | backup_type | 否 | String | **参数解释：** 备份类型。 **约束限制：** 不涉及。 **取值范围：** - Auto：自动全量备份 - Manual：手动全量备份。 - Incremental：增量备份。 - Differential：差异备份。 **默认取值：** 不涉及。 | | begin_time | 否 | String | **参数解释：** 查询备份开始的时间。 **约束限制：** 该时间为UTC时间。时间格式为"yyyy-mm-dd hh:mm:ss"。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | end_time | 否 | String | **参数解释：** 查询备份开始的结束时间。 **约束限制：** 该时间为UTC时间。时间格式为"yyyy-mm-dd hh:mm:ss"。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码： 202** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_count | Long | **参数解释：** 总记录数。 **取值范围：** 不涉及。 | | backups | Array of [表5] objects | **参数解释：** 备份信息列表。 | 表5backups | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 备份ID。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 备份名称。 **取值范围：** 不涉及。 | | description | String | **参数解释：** 备份描述信息。 **取值范围：** 不涉及。 | | begin_time | String | **参数解释：** 备份开始时间。 该时间为UTC时间，格式为"yyyy-mm-dd hh:mm:ss"。 **取值范围：** 不涉及。 | | end_time | String | **参数解释：** 备份结束时间。 该时间为UTC时间，格式为"yyyy-mm-dd hh:mm:ss"。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 备份状态。 **取值范围：** - BUILDING：备份中。 - COMPLETED：备份完成。 - FAILED：备份失败。 | | size | Double | **参数解释：** 备份大小，单位：KB。 **取值范围：** 不涉及。 | | type | String | **参数解释：** 备份类型。 **取值范围：** - Auto：自动全量备份。 - Manual：手动全量备份。 - Incremental：增量备份。 - Differential：差异备份。 | | instance_id | String | **参数解释：** 实例ID。 **取值范围：** 不涉及。 | | instance_name | String | **参数解释：** 实例名称。 **取值范围：** 不涉及。 | | datastore | [表6] object | **参数解释：** 数据库信息。 | 表6datastore | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释：** 数据库类型。 **取值范围：** - cassandra：表示查询GeminiDB Cassandra数据库实例。 - mongodb：表示GeminiDB Mongo查询数据库实例。 - influxdb：表示查询GeminiDB Influx数据库实例。 - redis：表示查询GeminiDB Redis数据库实例。 | | version | String | **参数解释：** 数据库版本。 **取值范围：** 不涉及。 | #### 请求示例 - 数据备份的增量备份文件大小和记录 ``` GET https://{Endpoint}/v3/2900b7b8d03e4619b8db8d43bc6234ee/backups?offset=1&limit=5&backup_type=Incremental&instance_id=3149aee486d748f68db1ee81e95b9f56in06 ``` - 数据备份的差异备份文件大小和记录 ``` GET https://{Endpoint}/v3/2900b7b8d03e4619b8db8d43bc6234ee/backups?offset=1&limit=5&backup_type=Differential&instance_id=3149aee486d748f68db1ee81e95b9f56in06 ``` #### 响应示例 **状态码： 202** Success ``` { "total_count" : 4, "backups" : [ { "id" : "43e4feaab48f11e89039fa163ebaa7e4br01", "name" : "backup-test", "instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br01", "instance_name" : "cluster-test", "datastore" : { "type" : "cassandra", "version" : "3.4" }, "type" : "Auto", "begin_time" : "2018-08-06 12:41:14", "end_time" : "2018-08-06 12:43:14", "status" : "COMPLETED", "size" : 2803, "description" : "backup description" }, { "id" : "43e4feaab48f11e89039fa163ebaa7e4br02", "name" : "backup-test-2", "instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br02", "instance_name" : "cluster-test", "datastore" : { "type" : "cassandra", "version" : "3.4" }, "type" : "Manual", "begin_time" : "2018-08-06 12:41:14", "end_time" : "2018-08-06 12:43:14", "status" : "COMPLETED", "size" : 2803, "description" : "backup description" } ] } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。