文档

ListBackupRecord - 查询备份记录列表

更新时间:

查询备份记录列表。

调试

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

授权信息

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

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

请求参数

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

要查询的防勒索策略防护的服务器的识别信息。可输入服务器的 IP 地址或实例 ID。

192.168.XX.XX
StatusListarray

备份任务状态列表。取值:

  • BACKUP_COMPLETE:备份成功
  • BACKUP_FAILED:备份失败
  • PARTIAL_COMPLETE:部分备份成功
string

备份任务状态列表。

["BACKUP_COMPLETE"]
BackupStartTimelong

备份开始时间,格式为时间戳(单位为毫秒)。

1699514211000
BackupEndTimelong

备份结束时间,格式为时间戳(单位为毫秒)。

1699600611000
CurrentPageinteger

设置从返回结果的第几页开始显示查询结果。默认值为 1,表示从第 1 页开始显示。

1
PageSizeinteger

分页查询时,每页显示的数据最大条数。每页默认显示的数据条数为 20 条,PageSize 参数值为空时,将默认返回 20 条数据。

说明 建议 PageSize 取值不要为空。
20

返回参数

名称类型描述示例值
object
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

3956048F-9D73-5EDB-834B-4827BB48****
BackupRecordListobject []

备份记录列表。

Uuidstring

数据库防勒索所备份服务器的 UUID。

b93cccb9-f19f-4886-97fe-47df26ba****
ClientIdstring

防勒索客户端 ID。

c-0002bgagelj3d2sc****
BackupPlanIdstring

备份计划 ID。

plan-000c4tt43nolmx96****
BackupJobIdstring

备份任务 ID。

a006f24d069843c88688672d74ee****
BackupStartTimelong

备份开始时间,格式为时间戳(单位为毫秒)。

1699514211000
BackupEndTimelong

备份结束时间,格式为时间戳(单位为毫秒)。

1699600611000
BackupStatusstring

备份任务状态。取值:

  • BACKUP_COMPLETE:备份成功
  • BACKUP_FAILED:备份失败
  • PARTIAL_COMPLETE:部分备份成功
BACKUP_COMPLETE
ErrorCodestring

备份任务错误码。

FILE_CACHE_NO_SPACE
ErrorMessagestring

备份任务错误详情。

FILE_CACHE_NO_SPACE
InstanceNamestring

资产的实例名称。

openapi
Ipstring

服务器 IP 地址。

1.1.1.1
InstanceIdstring

服务器实例的 ID。

i-wz9ikn44p46krnic****
InternetIpstring

服务器的公网 IP 地址。

1.1.1.1
IntranetIpstring

服务器私网 IP。

192.168.1.1
RegionIdstring

备份服务地域 ID。

cn-hangzhou
PageInfoobject

页面显示信息。

CurrentPageinteger

分页查询时,当前页的页码。

2
PageSizeinteger

分页查询时,每页最多显示的数据条数。

20
TotalCountinteger

查询到的数据总条数。

100
Countinteger

分页查询时,当前页显示数据条数。

20

示例

正常返回示例

JSON格式

{
  "RequestId": "3956048F-9D73-5EDB-834B-4827BB48****",
  "BackupRecordList": [
    {
      "Uuid": "b93cccb9-f19f-4886-97fe-47df26ba****",
      "ClientId": "c-0002bgagelj3d2sc****",
      "BackupPlanId": "plan-000c4tt43nolmx96****",
      "BackupJobId": "a006f24d069843c88688672d74ee****",
      "BackupStartTime": 1699514211000,
      "BackupEndTime": 1699600611000,
      "BackupStatus": "BACKUP_COMPLETE",
      "ErrorCode": "FILE_CACHE_NO_SPACE",
      "ErrorMessage": "FILE_CACHE_NO_SPACE",
      "InstanceName": "openapi",
      "Ip": "1.1.1.1",
      "InstanceId": "i-wz9ikn44p46krnic****",
      "InternetIp": "1.1.1.1\n",
      "IntranetIp": "192.168.1.1",
      "RegionId": "cn-hangzhou"
    }
  ],
  "PageInfo": {
    "CurrentPage": 2,
    "PageSize": 20,
    "TotalCount": 100,
    "Count": 20
  }
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

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

  • 本页导读 (1)
文档反馈