恢复一个暂存回收站中的文件。
接口说明
- 仅通用型 NAS 文件系统支持该功能。
- 单个文件系统一次只能执行一个文件恢复或清理任务。正在恢复文件时，无法发起新的文件恢复或清理任务。
- 单个恢复任务只能恢复一个文件或目录，恢复指定目录会递归恢复目录下的所有文件。
- 文件被恢复后会进行数据整理，数据整理期间读请求性能稍有下降。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| nas:CreateRecycleBinRestoreJob | create |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| FileSystemId | string | 是 | 文件系统 ID。 | 1ca404**** |
| FileId | string | 是 | 待恢复的文件或目录的 FileId。 您可以通过调用ListRecentlyRecycledDirectories 接口查询 FileId 信息。 | 04***08 |
| TargetFileId | string | 是 | 文件恢复后所存储目录的 FileId。 您可以通过调用 ListDirectoriesAndFiles 接口查询 TargetFileId 信息。 | 13***15 |
| ClientToken | string | 否 | 保证请求幂等性。 从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。更多信息，请参见如何保证幂等性。 说明
若您未指定 ClientToken，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
| 123e4567-e89b-12d3-a456-42665544**** |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****",
"JobId": "rb-10****491ff-r-162****165400"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | IllegalCharacters | The parameter contains illegal characters. | 参数非法。 |
| 400 | MissingFileSystemId | FileSystemId is mandatory for this action. | 未指定FileSystemId参数。 |
| 400 | MissingTargetFileId | TargetFileId is mandatory for this action. | 缺少TargetFileId参数。 |
| 400 | MissingFileId | FileId is mandatory for this action. | 缺少FileId参数。 |
| 400 | InvalidParameter.KMSKeyId.KMSUnauthorized | KMS is not authorized. | KMS服务未被授权访问。 |
| 400 | InvalidParameter.KMSKeyId.CMKNotEnabled | The CMK needs to be enabled. | 指定的CMK被disable需要处在启用状态。 |
| 403 | OperationDenied.RecycleBinDisabled | The operation is denied because the recycle bin is disabled. | 请求无法在回收站关闭状态下执行。 |
| 403 | OperationDenied.Conflict | The operation is in conflict with (% JobId). Please try again later. | 请求与其他job有冲突，请稍后再试。 |
| 403 | OperationDenied.TooManyRunningJobs | The maximum number of running job is one. Please try again later. | 运行中的job不能超过1个，请稍后再试。 |
| 403 | InvalidTargetFileId.NotDirectory | The specified TargetFileId(% TargetFileId) is not directory. | 指定的目标不是目录。 |
| 404 | InvalidFileSystem.NotFound | The specified file system does not exist. | 指定的文件系统不存在。 |
| 404 | InvalidFileId.NotFound | The specified FileId(%FileId) does not exist. | 指定的文件或目录不存在。 |
| 404 | InvalidTargetFileId.NotFound | The specified TargetFileId(%TargetFileId) does not exist. | 指定的目标目录不存在。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-09-05 | OpenAPI 错误码发生变更 | 查看变更详情 |