调用ListRecycleBinJobs接口查询回收站中的任务。

接口说明

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListRecycleBinJobs

接口名称。

固定取值:ListRecycleBinJobs

FileSystemId String 1ca404****

文件系统ID。

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

任务ID。

PageSize Long 10

分页查询时每页的行数。

取值范围:1~100

默认值:10

PageNumber Long 1

分页查询时当前的页码。

起始值(默认值):1

Status String All

任务状态。取值:

  • Running:运行中
  • Defragmenting:数据整理中
  • PartialSuccess:部分运行成功
  • Success:运行成功
  • Fail:运行失败
  • Cancelled:已取消
  • All:全部

返回数据

名称 类型 示例值 描述
RequestId String 9E15E394-38A6-457A-A62A-D9797C9A****

请求ID。

TotalCount Long 1

回收站中任务的总个数。

PageNumber Long 1

列表的分页页码。

PageSize Long 10

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

Jobs Array of Job

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

Id String 8C****C54

任务ID。

Type String Restore

任务类型。包括:

  • Restore:文件恢复任务
  • Delete:文件删除任务
FileId String 04***08

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

Status String Running

任务状态。包括:

  • Running:运行中
  • Defragmenting:数据整理中
  • PartialSuccess:部分运行成功
  • Success:运行成功
  • Fail:运行失败
  • Cancelled:已取消
ErrorCode String

错误码。

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

Progress String 100

查询任务的执行进度。

取值范围:1~100

CreateTime String 2021-05-30T10:08:08Z

任务创建时间。

FileName String test001

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

ErrorMessage String

错误信息。

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

示例

请求示例

http(s)://[Endpoint]/?Action=ListRecycleBinJobs
&FileSystemId=1ca404****
&JobId=rb-15****ed-r-1625****2441
&PageSize=10
&PageNumber=1
&Status=All
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListRecycleBinJobsResponse>
    <RequestId>9E15E394-38A6-457A-A62A-D9797C9A****</RequestId>
    <TotalCount>1</TotalCount>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <Jobs>
        <Id>8C****C54</Id>
        <Type>Restore</Type>
        <FileId>04***08</FileId>
        <Status>Running</Status>
        <ErrorCode>无</ErrorCode>
        <Progress>100</Progress>
        <CreateTime>2021-05-30T10:08:08Z</CreateTime>
        <FileName>test001</FileName>
        <ErrorMessage>无</ErrorMessage>
    </Jobs>
</ListRecycleBinJobsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "9E15E394-38A6-457A-A62A-D9797C9A****",
  "TotalCount" : 1,
  "PageNumber" : 1,
  "PageSize" : 10,
  "Jobs" : {
    "Id" : "8C****C54",
    "Type" : "Restore",
    "FileId" : "04***08",
    "Status" : "Running",
    "ErrorCode" : "无",
    "Progress" : 100,
    "CreateTime" : "2021-05-30T10:08:08Z",
    "FileName" : "test001",
    "ErrorMessage" : "无"
  }
}

错误码

HttpCode 错误码 错误信息 描述
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不存在。

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