CreateRestoreTask_数据灾备_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
dbs:CreateRestoreTask
Create
全部资源
*

请求参数

字段名称字段详情
BackupPlanIdstring

备份计划 ID。

示例值:dbs1hvb0ww****参考取值来源:
    StopBackupPlan
    UpgradeBackupPlan
    StartBackupPlan
    RenewBackupPlan
    CreateBackupPlan
    ReleaseBackupPlan
    ModifyBackupPlanName
    EnableBackupLog
    ConfigureBackupPlan
    DescribeBackupPlanList
    DisableBackupLog
DestinationEndpointInstanceTypestring

数据库所在位置,取值:展开详情

示例值:RDS
DestinationEndpointRegionstring

数据库实例的地域。展开详情

示例值:cn-hangzhou
DestinationEndpointInstanceIDstring

数据库实例 ID。展开详情

示例值:rm-bp1p8c29*****参考取值来源:
    DescribeRestoreTaskList
DestinationEndpointIPstring

数据库连接地址。展开详情

示例值:rm-bp*****9jv8pxero.mysql.rds.aliyuncs.com参考取值来源:
    DescribeRestoreTaskList
DestinationEndpointPortinteger<int32>

数据库端口。展开详情

示例值:3306
DestinationEndpointDatabaseNamestring

数据库名称。展开详情

示例值:test
DestinationEndpointUserNamestring

数据库账号。展开详情

示例值:test
DestinationEndpointPasswordstring

密码。展开详情

示例值:Test
BackupGatewayIdinteger<int64>

备份网关 ID。展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:4312****参考取值来源:
    DescribeBackupGatewayList
RestoreObjectsstring

恢复对象。展开详情

示例值:MySQL表级别恢复示例如下: [{\"DBName\":\"dbname\", \"NewDBName\":\"dbname1\"}]参考取值来源:
    DescribeRestoreTaskList
RestoreTimeinteger<int64>

恢复时间,取值:1554560477000。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1554560477000
BackupSetIdstring

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

示例值:dbs1hvb0w*****参考取值来源:
    CreateFullBackupSetDownload
    DescribeFullBackupList
RestoreTaskNamestring

恢复任务名称。

示例值:test参考取值来源:
    DescribeRestoreTaskList
DestinationEndpointOracleSIDstring

Oracle SID 名称。展开详情

示例值:test参考取值来源:
    DescribeRestoreTaskList
RestoreDirstring

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

示例值:test参考取值来源:
    DescribeRestoreTaskList
RestoreHomestring

数据库程序目录。

示例值:test
DuplicateConflictstring

同名对象冲突处理方式,当前支持:展开详情

示例值:renamenew
CrossAliyunIdstring

跨阿里云账号备份的 UID。

示例值:2749528728********
CrossRoleNamestring

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

示例值:test123
ClientTokenstring

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

示例值:ETnLKlblzczshOTUbOC********

返回参数

字段名称字段详情
HttpStatusCodeinteger<int32>

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。

示例值:s102h*****

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
403
Request.Forbidden
Have no Permissions诊断

变更历史

暂无变更历史