RestoreToNewInstance--云数据库 veDB MySQL 版-火山引擎

文档中心

立即注册

导航

RestoreToNewInstance

最近更新时间：2024.12.05 10:45:07首次发布时间：2023.07.26 13:58:16

调用 RestoreToNewInstance 接口将已有实例的备份数据恢复至一个新的实例中。

请求类型

异步请求。

请求参数

名称	类型	是否必选	示例值	描述
SrcInstanceId	String	是	vedbm-h441603c68aaa****	备份文件所属原实例的 ID。说明您可以调用 DescribeDBInstances 接口查询实例 ID。
BackupId	String	否	snap-64b7****-5935	原实例的备份文件 ID，使用该备份文件中保存的数据创建新实例。说明该参数与 RestoreTime 参数二者必须选择其一。您可以调用 DescribeBackups 查询指定实例的备份文件列表信息。
RestoreTime	String	否	2023-07-14T15:47:10Z	原实例日志备份保留时间内的任意时间点，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。说明该参数与 BackupId 参数二者必须选择其一。您可以调用 DescribeRecoverableTime 查询指定实例可恢复的时间范围。
InstanceName	String	否	Name123	实例名称。命名规则：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需在 1~128 个字符内。
DBMinorVersion	String	否	3.0	根据兼容版本，选择 veDB MySQL 小版本，默认与原实例保持一致。关于版本号的详细说明请参见版本号管理。当原实例兼容版本为 `MySQL_5_7` 时，该参数取值默认为 `2.0`。当原实例兼容版本为 `MySQL_8_0` 时，该参数取值范围如下： `3.0`：veDB MySQL 稳定版，100% 兼容 MySQL 8.0。 `3.1`：原生支持 HTAP 应用场景，加速复杂查询。 `3.2`：原生支持 HTAP 应用场景，加速复杂查询。此外，内置冷数据归档能力，可将低频访问的数据归档至对象存储 TOS 中，降低存储成本，详情请参见冷热分离介绍。说明仅支持由低版本向高版本恢复，如 veDB MySQL 3.1 可选择恢复为 veDB MySQL 3.2。 MySQL 5.7、HTAP 和冷热分离目前为白名单功能，如需使用，请提交工单联系技术支持。实例创建成功后，您需要立即为该实例创建分析节点，才能正常使用 HTAP 功能，详情请参见 ModifyDBInstanceSpec。
NodeSpec	String	是	vedb.mysql.x4.large	实例的规格代码。详细信息，请参见产品规格。
NodeNumber	Integer	是	2	实例的节点数量。取值范围为 2~16 个。
ZoneIds	String	是	cn-beijing-a	可用区 ID。说明您可以调用 DescribeAvailabilityZones 接口查询 veDB MySQL 实例支持的可用区资源。
VpcId	String	是	vpc-3ajzohyfaru9s340jz1rp****	私有网络（VPC） ID。说明您可以调用 DescribeVpcs 接口查询要创建实例的 VPC ID。
SubnetId	String	是	subnet-1g15j13jtzgu88ibuxwqp****	子网 ID。子网必须属于所选的可用区。说明子网是私有网络内的 IP 地址块，私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网 IP 地址。您可以调用 CreateSubnet 接口创建子网，调用 DescribeSubnets 接口查询指定可用区内的所有子网列表信息，包括子网 ID。
Port	Integer	否	3306	为实例默认创建的连接终端指定私网端口号。默认取值为 3306，取值范围为 1000~65534。说明该配置项仅对主节点终端、默认终端、HTAP集群终端生效。即实例创建成功后，新建的自定义终端，端口号依旧默认为 3306。实例创建成功后，您也可以随时修改端口号，当前仅支持通过控制台修改端口号，操作详情请参见修改连接地址前缀和端口。
ProjectName	String	否	default	实例所属的项目名称，当该参数留空时，新建的实例默认加入 `default` 项目。
SrcProjectName	String	否	default	源实例备份文件所属的项目名称。
Tags	Array of TagObject	否	请参见请求示例。	需要绑定的标签键和标签值数组对象。关于 Tags 的更多详情，请参见 TagObject。说明支持一次传入多组标签键值对象，多组标签键值对象间用英文逗号（,）分隔。单次最多同时传入 20 组标签键值对，单个实例最多绑定 50 个标签。标签键值需满足设置规则，具体规则请参见标签设置规则。
DeletionProtection	String	否	disabled	开启或关闭实例删除保护功能，取值范围： `enabled`：开启。 `disabled`：关闭（默认）。说明开启后，将无法删除该实例。如需删除实例，您需要先调用 ModifyDBInstanceDeletionProtectionPolicy 接口关闭该功能。关于删除保护的更多信息，请参见实例删除保护。
ChargeType	String	是	PostPaid	计算计费类型，默认与原实例保持一致。取值如下： `PostPaid`：按量计费（后付费）。 `PrePaid`：包年包月（预付费）。
StorageChargeType	String	否	PostPaid	存储计费类型，默认与原实例保持一致。不传入该参数时，存储计费类型默认与计算计费类型取值一致，取值如下： `PostPaid`：按量计费（后付费）。 `PrePaid`：包年包月（预付费）。注意当计算计费类型取值为 `PostPaid` 时，存储计费类型也只能取值为 `PostPaid`。当计算计费类型取值为 `PrePaid` 时，存储计费类型可取值为 `PrePaid` 或 `PostPaid`。
AutoRenew	Boolean	否	false	预付费场景下是否自动续费。取值： `true`：自动续费。 `false`：不自动续费。说明当 `ChargeType`（计费类型）取值为 `PrePaid`（包年包月）时，该参数必填。
PeriodUnit	String	否	Month	预付费场景下的购买周期。 `Month`：包月。 `Year`：包年。说明当 `ChargeType`（计费类型）取值为 `PrePaid`（包年包月）时，该参数必填。
Period	Integer	否	1	预付费场景下的购买时长。说明当 `ChargeType`（计费类型）取值为 `PrePaid`（包年包月）时，该参数必填。
PrePaidStorageInGB	Integer	否	50	预付费场景下的存储空间大小，说明当 `ChargeType`（计费类型）取值为 `PrePaid`（包年包月）时，该参数必填。

返回参数

名称	类型	示例值	描述
InstanceId	String	vedbm-h441603c68aaa****	实例 ID。
OrderId	String	Order707643373078888****	订单 ID。

请求示例

按备份集恢复

POST /?Action=RestoreToNewInstance&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: vedbm.volcengineapi.com
X-Date: 20220614T114308Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20220614/cn-beijing/vedbm/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****

{
        "ZoneIds": "cn-beijing-b",
        "NodeSpec": "vedb.mysql.x4.large",
        "NodeNumber": 2,
        "SrcInstanceId": "vedbm-gzwdsf9b****",
        "VpcId": "vpc-13fz0iip9nlds3n6nu4fi****",
        "SubnetId": "subnet-13fz1bsbrsw743n6nu47c****",
        "ProjectName": "default",
        "ChargeType": "PostPaid",
        "BackupId": "snap-64b7****-5935",
        "Tags": [{
            "Key": "chargetype",
            "Value": "prepaid"
        }],
        "InstanceName": "Name123"
}

按时间点恢复

POST /?Action=RestoreToNewInstance&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: vedbm.volcengineapi.com
X-Date: 20220614T114308Z
Authorization: HMAC-SHA256 Credential=AKIAIAGMBG4SXSQQ****/20220614/cn-beijing/veDB/request, SignedHeaders=accept;content-type;host;x-date, Signature=6a593bf5f59e7c1109fb205c739d1cff4c672fe2d251963f4d48c8701d16****

{
        "ZoneIds": "cn-beijing-b",
        "NodeSpec": "vedb.mysql.x4.large",
        "NodeNumber": 2,
        "SrcInstanceId": "vedbm-gzwdsf9b****",
        "VpcId": "vpc-13fz0iip9nlds3n6nu4fi****",
        "SubnetId": "subnet-13fz1bsbrsw743n6nu47c****",
        "ProjectName": "default",
        "ChargeType": "PostPaid",
        "RestoreTime": "2023-07-14T15:47:10Z",
        "Tags": [{
            "Key": "chargetype",
            "Value": "prepaid"
        }],
        "InstanceName": "Name123"
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "202307192136280102090801470751B90C",
        "Action": "RestoreToNewInstance",
        "Version": "2022-01-01",
        "Service": "vedbm",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstanceId": "vedbm-d4mx2akm****",
        "OrderId": "Order707643373078888****"
    }
}

错误码

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