CreateDBRestoreTask - 创建集合回档任务

更新时间:
复制 MD 格式

创建集合回档任务。创建回档任务成功后,会返回任务ID。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

mpserverless:CreateDBRestoreTask

create

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

SpaceId

string

服务空间 ID。

0e16bb12-14af-4635-b24c-5ac1a9a*****

BackupId

string

备份文件 ID。

20201118114602_6bd7c996-f620-4026-ae24-418eddf78671

OriginCollections

string

待回档集合名称,多个集合用英文逗号分隔,例如coll1,coll2

coll1,coll2

NewCollections

string

回档后的集合名称,不能和数据库中现有的文档名称相同,与 originCollections 一一对应,多个集合用英文逗号分隔,例如newColl1,newColl2

newColl1,newColl2

Mode

string

任务模式,取值区分大小写:

  • RESTORE:创建集合回档任务,需要传入 OriginCollections 和 NewCollections。

  • DOWNLOAD:创建备份下载任务,下载 BackupId 对应备份中由 OriginCollections 指定的集合,无需传入 NewCollections。 不传该参数时,默认执行回档。

DOWNLOAD

返回参数

名称

类型

描述

示例值

object

RequestId

string

唯一请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

TaskId

string

任务 ID。

0150006d-ab93-4920-a63e-c011dea1e089

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TaskId": "0150006d-ab93-4920-a63e-c011dea1e089"
}

错误码

HTTP status code

错误码

错误信息

描述

400 AccessDenied You are not authorized to access this space. 没有访问该Space的权限。

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

变更历史

更多信息,参考变更详情