CreateRestoreTask - 创建恢复任务

调用CreateRestoreTask接口,创建DBS恢复任务。

调试

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

调试

授权信息

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

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

    请求参数

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

    备份计划ID。

    dbs1hvb0wwXXXX
    DestinationEndpointInstanceTypestring

    数据库所在位置,取值:

    • RDS
    • ECS
    • Express:通过专线/VPN网关/智能网关接入的数据库
    • Agent:通过备份网关接入的数据库
    • DDS:云MongoDB
    • Other:通过IP:Port直连的数据库
    RDS
    DestinationEndpointRegionstring

    数据库地域。

    说明DestinationEndpointInstanceType为RDS、ECS、DDS、Express、Agent时,该参数必传。
    100.X.X.10:33204
    DestinationEndpointInstanceIDstring

    数据库实例ID。

    说明DestinationEndpointInstanceType为RDS、ECS、DDS、Express时,该参数必传。
    rm-bp1p8c29XXXXX
    DestinationEndpointIPstring

    数据库连接地址。

    说明DestinationEndpointInstanceType为express、agent、other,该参数必传。
    rm-bpXXXXX9jv8pxero.mysql.rds.aliyuncs.com
    DestinationEndpointPortinteger

    数据库端口。

    说明DestinationEndpointInstanceType为express、agent、other、ECS,该参数必传。
    3306
    DestinationEndpointDatabaseNamestring

    数据库名称。

    说明数据库类型为PostgreSQL、MongoDB时,该参数必传。
    test
    DestinationEndpointUserNamestring

    数据库账号。

    说明数据库类型为Redis,或者数据库所在位置为agent且数据库类型为MSSQL时该参数非必须,其他场景均必传。
    test
    DestinationEndpointPasswordstring

    密码。

    说明数据库类型为Redis,或者数据库所在位置为agent且数据库类型为MSSQL时该参数非必须,其他场景均必传。
    Test
    BackupGatewayIdLong

    备份网关ID。

    说明DestinationEndpointInstanceType为agent时,该参数必传。
    43123424
    RestoreObjectsstring

    恢复对象。

    说明详见下面的RestoreObjects参数定义,当数据库所在位置为agent时,该参数非必须,其他场景均必传。
    [ { "DBName":"待恢复库名", "NewDBName":"目标待恢复库名", "SchemaName":"待恢复 Schema 名", "NewSchemaName":"目标待恢复 Schema 名"}]
    RestoreTimeLong

    恢复时间,取值:1554560477000。

    1554560477000
    BackupSetIdstring

    恢复所使用的全量备份集ID,和RestoreTime互斥。

    dbs1hvb0wXXXXX
    RestoreTaskNamestring

    恢复任务名称。

    test
    DestinationEndpointOracleSIDstring

    Oracle SID名称。

    说明数据库类型为Oracle时,该参数必传。
    test
    RestoreDirstring

    DestinationEndpointInstanceType为agent且备份计划为MySQL时必传。

    test
    RestoreHomestring

    数据库程序目录。

    test
    DuplicateConflictstring

    同名对象冲突处理方式,取值:

    • failure:遇到同名对象则失败(默认值)
    • renamenew:遇到同名对象则重命名
    failure
    CrossAliyunIdstring

    跨阿里云账号备份的uid。

    2xxx7778xxxxxxxxxx
    CrossRoleNamestring

    跨阿里云账号备份的RAM角色名称。

    test123
    ClientTokenstring

    用于保证请求的幂等性,防止重复提交请求。

    ETnLKlblzczshOTUbOCzxxxxxxx

    返回参数

    名称类型描述示例值
    object
    HttpStatusCodeinteger

    HTTP状态码。

    200
    RequestIdstring

    请求ID。

    60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC
    ErrCodestring

    错误码。

    Param.NotFound
    Successboolean

    是否成功。

    true
    ErrMessagestring

    错误信息。

    The specified parameter %s value is not valid.
    RestoreTaskIdstring

    恢复任务ID。

    s102hXXXXX

    示例

    请求示例

    http(s)://dbs-api.cn-hangzhou.aliyuncs.com/?Action=CreateRestoreTask
    &BackupPlanId=dbs1hvb0wwXXXX
    &DestinationEndpointInstanceType=rds
    &RestoreTaskName=test
    &<公共请求参数>
    

    正常返回示例

    JSON格式

    {
    	"RestoreTaskId": "s102hXXXXX",
    	"RequestId": "60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC",
    	"HttpStatusCode": 200,
    	"Success": true
    }

    XML格式

    <CreateRestoreTaskResponse>
    <RestoreTaskId>s102hXXXXX</RestoreTaskId>
    <RequestId>60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC</RequestId>
    <HttpStatusCode>200</HttpStatusCode>
    <Success>true</Success>
    </CreateRestoreTaskResponse>
    

    错误码

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

    阿里云首页 数据库备份 DBS 相关技术圈