# 查询备份列表 - QueryingBackups #### 功能介绍 根据指定条件查询备份列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDBforNoSQL/doc?api=ListBackups)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbfornosql:backup:list | List | - | - | nosql:backup:list | - | #### URI GET /v4/{project_id}/backups 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | instance_id | 否 | String | **参数解释：** 实例ID。可以调用[查询实例列表和详情 - QueryingInstancesandDetails](https://support.huaweicloud.com/api-nosql/nosql_05_0016.html)接口获取。如果未申请实例，可以调用[创建实例 - CreatinganInstance](https://support.huaweicloud.com/api-nosql/nosql_05_0014.html)接口创建。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | datastore_type | 否 | String | **参数解释：** 数据库类型。 **约束限制：** 不涉及。 **取值范围：** - cassandra：表示查询GeminiDB Cassandra数据库实例。 - redis：表示GeminiDB Redis查询数据库实例。 - mongodb：表示查询GeminiDB Mongo数据库实例。 - influxdb：表示查询GeminiDB Influx数据库实例。 **默认取值：** 不涉及。 | | backup_id | 否 | String | **参数解释：** 备份文件ID。 获取方式请参见"[查询备份列表](https://support.huaweicloud.com/api-nosql/nosql_12_0011.html)"响应参数"backups"。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | backup_type | 否 | String | **参数解释：** 备份类型。 **约束限制：** 大小写敏感。 **取值范围：** - 取值为"Auto"，表示自动全量备份。 - 取值为"Manual"，表示手动全量备份。 **默认取值：** 当该字段未传入值时，默认只查询所有的全量备份(包含库表级)，包括自动全备备份和手动全量备份。 | | type | 否 | String | **参数解释：** 备份策略类型。 **约束限制：** 不涉及。 **取值范围：** - Instance：表示查询实例级备份。 - DatabaseTable：表示查询库表级备份。 **默认取值：** Instance。 | | limit | 否 | Integer | **参数解释：** 查询备份个数上限值，单位：条。 **约束限制：** 不涉及。 **取值范围：** 1-100。 **默认取值：** 不传该参数时，默认查询前100条实例信息。 | | offset | 否 | Integer | **参数解释：** 索引位置偏移量，表示从指定project ID下最新的备份创建时间开始，按时间的先后顺序偏移offset条数据后查询对应的备份信息，单位：条。 **约束限制：** 不涉及。 **取值范围：** 取值大于或等于0。 **默认取值：** 不传该参数时，查询偏移量默认为0，表示从最新的备份创建时间对应的备份开始查询。 | | begin_time | 否 | String | **参数解释：** 查询备份开始的时间。为yyyy-mm-ddThh:mm:ssZ字符串格式，T指某个时间的开始，Z指时区偏移量。 **约束限制：** 当"end_time"有值时，"begin_time"必选。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | end_time | 否 | String | **参数解释：** 查询备份结束的时间。为yyyy-mm-ddThh:mm:ssZ字符串格式，T指某个时间的开始，Z指时区偏移量。 **约束限制：** 当"begin_time"有值时，"end_time"必选。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_count | Integer | **参数解释：** 备份总数量。 **取值范围：** 不涉及。 | | backups | Array of [表5] objects | **参数解释：** 备份详情列表。 | 表5Backup | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 备份ID。 **取值范围：** 不涉及。 | | description | String | **参数解释：** 备份描述信息。 **取值范围：** 不涉及。 | | instance_id | String | **参数解释：** 备份所属的实例ID。 **取值范围：** 不涉及。 | | instance_name | String | **参数解释：** 备份所属的实例名称。 **取值范围：** 不涉及。 | | datastore | [表6] object | **参数解释：** 数据库版本信息。 | | name | String | **参数解释：** 备份名称。 **取值范围：** 不涉及。 | | type | String | **参数解释：** 备份类型。 **取值范围：** - 取值为"Auto"，表示自动全量备份。 - 取值为"Manual"，表示手动全量备份。 | | size | Double | **参数解释：** 备份大小，单位：KB。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 备份状态。 **取值范围**： - BUILDING：备份中。 - COMPLETED：备份完成。 - FAILED：备份失败。 | | begin_time | String | **参数解释：** 备份开始时间。为yyyy-mm-ddThh:mm:ssZ字符串格式，T指某个时间的开始，Z指时区偏移量。 **取值范围：** 不涉及。 | | end_time | String | **参数解释：** 备份结束时间。为yyyy-mm-ddThh:mm:ssZ字符串格式，T指某个时间的开始，Z指时区偏移量。 **取值范围：** 不涉及。 | | database_tables | Array of [表7] objects | **参数解释：** 备份里的库表信息。 - 实例级查询时该字段为空，可忽略。 - 库表级查询时该字段非空（存在库表级备份的话）。 **取值范围：** 不涉及。 | 表6Datastore | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释：** 数据库类型。 **取值范围：** 不涉及。 | | version | String | **参数解释：** 数据库版本。 **取值范围：** 不涉及。 | 表7QueryDatabaseTableInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | database_name | String | **参数解释：** 数据库名称。 **取值范围：** 不涉及。 | | table_names | Array of strings | **参数解释：** 表名称列表。 - table_names为空的时候，表示库级别查询。 - table_names非空的时候，表示表级别查询。 | #### 请求示例 URI样例 ``` GET https://{Endpoint}/v4/ 054b61972980d4552f0bc00ac8d3f5cd/backups?instance_id=c0c9f155c7b7423a9d30f0175998b63bin01&offset=2&limit=2&begin_time=2019-05-27T03:38:51+0000&end_time=2019-05-28T03:38:51+0000&type=DatabaseTable ``` #### 响应示例 **状态码： 200** 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" : "2019-05-27T03:38:51+0000", "end_time" : "2019-05-27T03:39:51+0000", "status" : "COMPLETED", "size" : 2803, "description" : "backup description", "database_tables" : [ { "database_name" : "DATABASE_X", "table_names" : [ "TABLE_A", "TABLE_B", "TABLE_C" ] }, { "database_name" : "DATABASE_Y", "table_names" : [ "TABLE_D" ] } ] }, { "id" : "43e4feaab48f11e89039fa163ebaa7e4br02", "name" : "backup-test-2", "instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br02", "instance_name" : "cluster-test", "datastore" : { "type" : "cassandra", "version" : "3.4" }, "type" : "Manual", "begin_time" : "2019-05-27T03:38:51+0000", "end_time" : "2019-05-27T03:39:51+0000", "status" : "COMPLETED", "size" : 2803, "description" : "backup description", "database_tables" : [ { "database_name" : "DATABASE_X", "table_names" : [ "TABLE_A", "TABLE_B", "TABLE_C" ] }, { "database_name" : "DATABASE_Y", "table_names" : [ "TABLE_D" ] } ] } ] } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。