CreateTosRestore--云数据库 SQL Server 版-火山引擎

文档中心

立即注册

导航

CreateTosRestore

最近更新时间：2024.02.02 14:42:57首次发布时间：2023.08.25 11:59:39

调用 CreateTosRestore 接口将对象存储 TOS 上的备份文件恢复到云数据库 SQL Server 版实例，实现数据上云。

请求类型

异步请求。

请求参数

名称	类型	是否必选	示例值	描述
TargetDBInstanceId	String	是	mssql-d59138f3****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询实例 ID。
TosObjectPositions	String	是	tos-cn-beijing.volces.com:backname:slow_query.log	TOS 的对象地址。格式为 `<TOS Endpoint 地址>:<TOS Bucket 名称>:<TOS 上的备份文件名称>`，用英文冒号（:）分隔。说明 TOS 上的备份文件格式当前仅支持 `.bak`、`.diff`、`.trn`、`.log`。
Databases	Array of DatabaseObject	是	DatabaseObject	待恢复的数据库信息。说明单次最多可恢复 20 个数据库信息。
RestoreType	String	否	FULL	恢复任务类型，取值如下： `FULL`：全量恢复（默认值）。 `DIFF`：差异恢复。 `LOG`：日志恢复。
IsOnline	Boolean	否	true	是否上线恢复后的数据库，方便访问，取值如下： `true`：表示上线恢复后的数据库。 `false`：表示不上线恢复后的数据库（默认值）。
IsReplace	Boolean	否	false	恢复时是否覆盖目标实例上已经存在的数据库，当前仅支持取值 `false`，表示恢复时不覆盖目标实例上已经存在的数据库。

返回参数

名称	类型	示例值	描述
RestoreTaskId	String	490	恢复任务 ID。

请求示例

POST /?Action=CreateTosRestore&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mssql.volcengineapi.com
X-Date: 20230131T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mssql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****

{
    "TargetDBInstanceId":"mssql-1be522b5****",
    "TosObjectPositions":"tos-cn-beijing.volces.com:huahua:slow_query.log",
    "Databases":[
        {
        "DBName":"123",
        "NewDBName":"testname"
    }]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230823153339243D5B69711EB66B4DEF",
        "Action": "CreateTosRestore",
        "Version": "2022-01-01",
        "Service": "rds_mssql",
        "Region": "cn-beijing"
    },
    "Result": {
        "RestoreTaskId": "490"
    }
}

错误码

更多详情，请参见错误码。