ListBackups - 获取备份列表

列表查询计算巢实例备份

接口说明

前提条件

请先确认服务商在创建服务时开启变配功能并完成变配参数设置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
computenest:ListBackupslist
*全部资源
*

请求参数

名称类型必填描述示例值
MaxResultsinteger

分页大小。

20
NextTokenstring

下一个查询开始 Token。

AAAAAc3HCuYhJi/wvpk4xOr0VLYoaeZA6xVdkCrmG9EmGshtmECUGpq9Qm7x5vQkpz9NXH0XzUc9t4Kxaf3UtuPY4a0=
Filterarray<object>

过滤器。

object

过滤器。

Valuearray

过滤器列表。

string

过滤器值列表。

si-xxx
Namestring

过滤器名称,可选择一个或者多个名称进行查询。取值范围:

  • BackupId:备份 ID。

  • ServiceInstanceId:服务实例 ID。

  • Status:状态。

  • StartTime:开始时间。

  • EndTime:结束时间。

ServiceInstanceId

返回参数

名称类型描述示例值
object

Schema of Response

TotalCountinteger

TotalCount 本次请求条件下的数据总量

1
RequestIdstring

请求 ID

BB58FE53-ED8F-5D12-9746-CD3A5F463D95
NextTokenstring

表示当前调用返回读取到的位置,空代表数据已经读取完毕

AAAAAc3HCuYhJi/wvpk4xOr0VLYoaeZA6xVdkCrmG9EmGshtmECUGpq9Qm7x5vQkpz9NXH0XzUc9t4Kxaf3UtuPY4a0=
MaxResultsinteger

MaxResults 本次请求所返回的最大记录条数

100
Backupsarray<object>

备份列表。

Backupobject

备份详情。

BackupIdstring

备份 ID

backup-4e13aa8ca6a34150addd
ServiceInstanceIdstring

服务实例 ID。

si-7b6138dfce1e4c41ab71
StartTimestring

备份开始时间

2025-06-30T16:00:00Z
EndTimestring

备份结束时间

2024-08-15T02:24:00Z
Statusstring

状态

  • Creating 创建中
  • Created 创建成功
  • CreateFailed 创建失败
  • Deleting 删除中
  • Deleted 删除成功
  • DeleteFailed 删除失败
Creating
Descriptionstring

备份描述

No description
BackupModestring

备份模式,返回值:

  • Manual:手动备份。
Manual
RetentionDaysinteger

保留天数。过期会被清理。默认为空不过期。

1
StatusDetailstring

服务实例的部署信息描述。

Disk i-xxxx backup failed, error message: error
ModifiedTimestring

更新时间

2024-09-03T19:54:38+08:00
CreateTimestring

创建时间

2024-09-03T19:54:38+08:00

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "RequestId": "BB58FE53-ED8F-5D12-9746-CD3A5F463D95",
  "NextToken": "AAAAAc3HCuYhJi/wvpk4xOr0VLYoaeZA6xVdkCrmG9EmGshtmECUGpq9Qm7x5vQkpz9NXH0XzUc9t4Kxaf3UtuPY4a0=",
  "MaxResults": 100,
  "Backups": [
    {
      "BackupId": "backup-4e13aa8ca6a34150addd",
      "ServiceInstanceId": "si-7b6138dfce1e4c41ab71",
      "StartTime": "2025-06-30T16:00:00Z",
      "EndTime": "2024-08-15T02:24:00Z",
      "Status": "Creating",
      "Description": "No description",
      "BackupMode": "Manual",
      "RetentionDays": 1,
      "StatusDetail": "Disk i-xxxx backup failed, error message: error\t",
      "ModifiedTime": "2024-09-03T19:54:38+08:00",
      "CreateTime": "2024-09-03T19:54:38+08:00"
    }
  ]
}

错误码

访问错误中心查看更多错误码。