ListRecycleBinJobs - 查询回收站中的任务列表

更新时间:
复制 MD 格式

查询回收站中的一个或多个任务信息。

接口说明

  • 仅通用型 NAS 文件系统支持该功能。

  • 最多可以查询最近执行的 50 个任务。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

nas:ListRecycleBinJobs

get

*FileSystem

acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}

请求参数

名称

类型

必填

描述

示例值

FileSystemId

string

文件系统 ID。

1ca404****

JobId

string

任务 ID。

rb-15****ed-r-1625****2441

PageSize

integer

分页查询时每页的行数。

取值范围:1~100

默认值:10

10

PageNumber

integer

分页查询时当前的页码。

起始值(默认值):1

1

Status

string

任务状态。取值:

  • Running:运行中

  • Defragmenting:数据整理中

  • PartialSuccess:部分运行成功

  • Success:运行成功

  • Fail:运行失败

  • Cancelled:已取消

  • All(默认值):全部

枚举值:

  • All :

    全部

  • Defragmenting :

    数据整理中

  • Running :

    运行中

  • PartialSuccess :

    部分运行成功

  • Cancelled :

    已取消

  • Success :

    运行成功

  • Fail :

    运行失败

All

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

9E15E394-38A6-457A-A62A-D9797C9A****

TotalCount

integer

回收站中任务的总个数。

1

PageNumber

integer

列表的分页页码。

1

PageSize

integer

每个分页包含的任务个数。

10

Jobs

array<object>

回收站中的任务信息集合。

object

Id

string

任务 ID。

8C****C54

Type

string

任务类型。包括:

  • Restore:文件恢复任务

  • Delete:文件删除任务

Restore

FileId

string

任务对应文件或目录的 FileId。

04***08

Status

string

任务状态。包括:

  • Running:运行中

  • Defragmenting:数据整理中

  • PartialSuccess:部分运行成功

  • Success:运行成功

  • Fail:运行失败

  • Cancelled:已取消

Fail

ErrorCode

string

错误码。

当 Status 为 Fail 或 PartialSuccess 时,该返回值有效。

InvalidFileId.NotFound

Progress

string

查询任务的执行进度。

取值范围:1~100

100

CreateTime

string

任务创建时间。按照 ISO 8601 标准表示,并使用 UTC 时间。格式为:yyyy-MM-ddTHH:mm:ssZ。

2021-05-30T10:08:08Z

FileName

string

任务对应文件或目录的名称。

test001

ErrorMessage

string

错误信息。

当 JobStatus 为 Fail 或 PartialSuccess 时,该返回值有效。

The Target File or Directory does not exist.

示例

正常返回示例

JSON格式

{
  "RequestId": "9E15E394-38A6-457A-A62A-D9797C9A****",
  "TotalCount": 1,
  "PageNumber": 1,
  "PageSize": 10,
  "Jobs": [
    {
      "Id": "8C****C54",
      "Type": "Restore",
      "FileId": "04***08",
      "Status": "Fail",
      "ErrorCode": "InvalidFileId.NotFound",
      "Progress": "100",
      "CreateTime": "2021-05-30T10:08:08Z",
      "FileName": "test001",
      "ErrorMessage": "The Target File or Directory does not exist."
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

400 IllegalCharacters The parameter contains illegal characters. 参数非法。
400 MissingFileSystemId FileSystemId is mandatory for this action. 未指定FileSystemId参数。
400 InvalidStatus Specified parameter Status is not valid. 指定的Status非法。
404 InvalidFileSystem.NotFound The specified file system does not exist. 指定的文件系统不存在。
404 InvalidJobId.NotFound The specified JobId(%JobId) does not exist. 指定的任务ID不存在。

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

变更历史

更多信息,参考变更详情