查询指定实例全量备份列表 - ShowInstanceBackups
功能介绍
查询指定实例全量备份列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
GET /v3/{project_id}/instances/{instance_id}/backups
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
instance_id | 是 | String | 参数解释: 实例ID,此参数是实例的唯一标识。 获取方法请参见查询实例列表。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,后缀为in07,长度为36个字符。 默认取值: 不涉及。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
offset | 否 | String | 参数解释: 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制: 必须为整数,不能为负数。 取值范围: ≥0。 默认取值: 0。 |
limit | 否 | String | 参数解释: 查询记录数。 约束限制: 必须为整数,不能为负数。 取值范围: 1-100。 默认取值: 100。 |
order_field | 否 | String | 参数解释: 根据指定字段排序。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
order_rule | 否 | String | 参数解释: 排序规则。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
filter_field | 否 | String | 参数解释: 过滤字段类型。 约束限制: 不涉及。 取值范围: name:根据备份名称进行过滤。 默认取值: 不涉及。 |
filter_content | 否 | String | 参数解释: 过滤内容。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
X-Language | 否 | String | 参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围: 默认取值: en-us。 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
backups | Array of BackupV3 objects | 参数解释: 指定实例全量备份信息列表。 |
total_count | String | 参数解释: 总备份数量。 取值范围: 不涉及。 |
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | 参数解释: 备份ID。 取值范围: 不涉及。 |
description | String | 参数解释: 备份描述。 取值范围: 不涉及。 |
instance_id | String | 参数解释: 实例ID。 取值范围: 不涉及。 |
instance_name | String | 参数解释: 实例名称。 取值范围: 不涉及。 |
name | String | 参数解释: 备份名称。 取值范围: 不涉及。 |
size | String | 参数解释: 备份大小。 取值范围: 不涉及。 |
size_unit | String | 参数解释: 大小单位(KB)。 取值范围: 不涉及。 |
status | String | 参数解释: 备份状态。 取值范围: |
created | String | 参数解释: 创建时间。 取值范围: 不涉及。 |
updated | String | 参数解释: 更新时间。 取值范围: 不涉及。 |
backup_type | String | 参数解释: 备份类型。 取值范围: |
backup_level | String | 参数解释: 备份级别。 取值范围: |
backup_method | String | 参数解释: 备份方法。 取值范围: |
use_detail | String | 参数解释: 使用详情。 取值范围: 不涉及。 |
time_zone | String | 参数解释: UTC时区。 取值范围: 不涉及。 |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误消息。 |
状态码:500
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误消息。 |
请求示例
查询实例的备份列表。
GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/backups?offset=0&limit=100 响应示例
状态码:200
Success.
{
"backups" : [ {
"id" : "backup-001",
"description" : "每日自动备份",
"instance_id" : "instance-123",
"instance_name" : "prod-db",
"name" : "daily-backup-20231101",
"size" : "74464.0",
"size_unit" : "KB",
"status" : "COMPLETED",
"created" : "2026-01-04 17:30:30",
"updated" : "2026-01-04 17:34:24",
"backup_type" : "Db",
"backup_level" : "2",
"backup_method" : "Db",
"use_detail" : "生产环境备份",
"time_zone" : "UTC+08:00"
} ],
"total_count" : "1"
} 状态码
状态码 | 描述 |
|---|---|
200 | Success. |
400 | Client error. |
500 | Server error. |
错误码
请参见错误码。

