ListBackups - 查询备份列表_密钥管理服务(KMS)-阿里云帮助中心

获取符合查询条件的备份集合。

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-hsm:ListBackups	list	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
CurrentPage	long	是	当前分页。	1
PageSize	long	是	每页显示的备份个数。取值：1~1000。	20
Name	string	否	备份名称。	hsm-te****
BackupId	string	否	备份 ID。	backup-1648438****
InstanceId	string	否	密码机实例 ID。	hsm-cn-vj30bil8****

返回参数

名称	类型	描述	示例值
	object	响应信息。
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	4C467B38-3910-447D-87BC-AC049166F216
TotalCount	integer	查询结果总数。	30
PageSize	integer	每页显示的备份个数。	20
CurrentPage	integer	当前分页。	1
Backups	array<object>	返回的备份列表。
	object	备份详情。
BackupId	string	备份 ID。	backup-1648438****
CreateTime	long	备份创建时间，精确到毫秒。时间戳格式。	1637229596000
ExpireTime	long	备份过期时间，精确到毫秒。时间戳格式。	1682417553781
InstanceId	string	备份关联的密码机实例 ID。	hsm-cn-vj30bil8****
Name	string	备份名称。	backup-te****
RegionId	string	区域 ID。	ap-southeast-1
Remark	string	备份备注。	normal backup
Status	string	备份状态。 NEW：未启用 EXPIRED：已过期 ENABLED：已启用	ENABLED
MaxImageCount	string	镜像数量。	3
Type	string	备份类型。 DEFAULT：默认备份 NORMAL：普通备份	NORMAL
BackupPeriod	long	自动备份周期，单位天数。	3
NextImageCreateTime	long	镜像下一次创建时间，精确到毫秒。时间戳格式。	1682417553781
AutoImageCount	long	自动备份镜像数量。	1
BackupHourInDay	string	备份时间，24 小时制整点时间。	13
SpInstanceId	string	售卖域备份 ID。仅中国内地密码机备份有此属性。	backup-fdb897sdfg534-****
ReleaseTime	long	备份释放时间，精确到毫秒。时间戳格式。	1641275680000
OwnerInstanceId	string	备份所属的密码机实例 ID。仅非中国内地密码机备份有此属性，且与 InstanceId 一致。	hsm-cn-vj30bil8****

示例

正常返回示例

JSON格式

{
  "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
  "TotalCount": 30,
  "PageSize": 20,
  "CurrentPage": 1,
  "Backups": [
    {
      "BackupId": "backup-1648438****",
      "CreateTime": 1637229596000,
      "ExpireTime": 1682417553781,
      "InstanceId": "hsm-cn-vj30bil8****",
      "Name": "backup-te****",
      "RegionId": "ap-southeast-1",
      "Remark": "normal backup",
      "Status": "ENABLED",
      "MaxImageCount": "3",
      "Type": "NORMAL",
      "BackupPeriod": 3,
      "NextImageCreateTime": 1682417553781,
      "AutoImageCount": 1,
      "BackupHourInDay": "13",
      "SpInstanceId": "backup-fdb897sdfg534-****",
      "ReleaseTime": 1641275680000,
      "OwnerInstanceId": "hsm-cn-vj30bil8****"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息
403	NoPermission	caller has no permission

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