You need to enable JavaScript to run this app.
导航
RestoreToNewInstance
最近更新时间:2024.11.05 16:00:06首次发布时间:2023.02.02 17:41:22

调用 RestoreToNewInstance 接口将数据恢复到一个新实例。

请求类型

异步请求。

注意事项

当前不支持将单可用区实例恢复为多可用区实例,或将多可用区实例恢复为单可用区实例。

调试

请求参数

参数
类型
是否必选
示例值
描述
SrcInstanceId
String
mysql-603e30e6****
备份数据所属的原实例的 ID。
BackupId
String
2b18d7e970c442caae05be478a9e****

备份文件 ID。通过调用 DescribeBackups 可查询 BackupID。

说明

  • 该参数与 RestoreTime 参数二者必选其一。
  • 可选择物理备份或逻辑备份的备份集进行恢复。使用逻辑备份进行恢复时,仅支持将备份中所有非系统数据库的表的数据结构和内容恢复到新实例。
RestoreTime
String
2022-01-01T10:10:10Z

原实例备份保留周期内的任意时间点,格式为 yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。通过调用 DescribeRecoverableTime 可查询该时间点是否支持还原。

说明

该参数与 BackupId 参数二者必选其一。

NodeInfo
Object[]
[ { "NodeType": "Primary", "NodeSpec": "rds.mysql.d1.1c2g" "ZoneId": "cn-beijing-a" }, { "NodeType": "Secondary", "NodeSpec": "rds.mysql.d1.1c2g" "ZoneId": "cn-beijing-a" }, { "NodeType": "ReadOnly", "NodeSpec": "rds.mysql.d1.1c2g" "ZoneId": "cn-beijing-a" } ]
实例规格配置。主节点和备节点有且只有 1 个,只读节点可选 0~10 个。
StorageType
String
LocalSSD

实例存储类型。取值为 LocalSSD,表示本地 SSD 盘。

说明

在 ModifyDBInstanceSpec 接口中,如需设定 StorageSpace 参数,StorageType 参数为必传。

StorageSpace
Integer
100
实例存储空间。取值范围:[20, 3000],单位为 GB,步长为 10GB。默认值为原实例空间大小。
VpcId
String
vpc-2d70di2hrnbpc58ozfdx9****

私有网络(VPC) ID。可调用 DescribeVpcs 查询。

说明

不支持使用共享 VPC。

SubnetId
String
subnet-2d70dj20bob9c58ozfek6****
子网 ID。 可调用 DescribeSubnets 通过指定 VpcId 和 ZoneId (主节点或备节点所在的可用区)查询可用的子网。
Port
Integer
3306
默认终端的私网端口。端口号的取值范围为 1000~65534,默认值为 3306。
创建新的连接终端或开启新地址时,将使用默认终端的私网端口实时配置为默认端口。
AllowListIds
String[]
[ "acl-a29be2559dc4406883d358892b90****", "acl-ded4c0b707e44efd8f0dbc4e88f5****" ]

白名单 ID。如需绑定多个白名单,白名单 ID 用英文逗号(,)分隔。一个实例最多可绑定 100 个白名单。

说明

通过 RestoreToNewInstance 接口恢复到新实例时默认不会绑定源实例的白名单。如有需要,您可在调用该接口前,通过调用 DescribeAllowLists 查询源实例所绑定的白名单,并将其写入该字段;也可以在恢复到新实例后,通过调用 AssociateAllowList 接口绑定白名单到新实例。

InstanceName
String
Name123

实例名称。实例名称的命名规则如下:

  • 不能以数字、中划线开头。
  • 只能包含中文、字母、数字、下划线和中划线。
  • 长度限制在 1~128 之间。
DBParamGroupId
String
mysql-sys-6013c7b8f7ef****
参数模板 ID。默认值为数据库引擎版本对应的默认参数模板。
ProjectName
String
Test
所属项目。
ChargeInfo
Object
{ "ChargeType": "PostPaid" }
付费方式。
InstanceTags
Object[]
[ { "Key":"key1", "Value":"value1" }, { "Key":"key2", "Value":"value2" } ]
实例标签。

返回参数

参数
类型
示例值
描述
InstanceId
String
mysql-e7fda57b****
恢复的新实例的实例 ID。
OrderId
String
Order709899242175681****
订单 ID。

示例

请求示例

POST /?Action=RestoreToNewInstance&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "SrcInstanceId": "mysql-603e30e6****",
    "BackupId": "9671e15707ca44a1b9d8c8fc3e9f****",
    "NodeInfo": [
        {
            "NodeType": "Primary",
            "ZoneId": "cn-beijing",
            "NodeSpec": "rds.mysql.1c2g"
        },
        {
            "NodeType": "Secondary",
            "ZoneId": "cn-beijing",
            "NodeSpec": "rds.mysql.1c2g"
        }
    ],
    "StorageType": "LocalSSD",
    "SubnetId": "subnet-2gcy3ey5i9reo50ztyzo6****",
    "VpcId": "vpc-3jhamu8itr5ds3pncmf9q****",
    "AllowListIds": [
        "acl-3929ba6fd27049e88ee772dc7b46****"
    ],
    "Port": 3306,
    "InstanceName": "备份恢复样例",
    "ChargeInfo": {
        "ChargeType": "PostPaid"
    },
    "InstanceTags": [
        {
            "Key": "key1",
            "Value": "value1"
        },
        {
            "Key": "key2",
            "Value": "value2"
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202305081052028E9DB7D3AD66FA6FFCE0",
        "Action": "RestoreToNewInstance",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstanceId": "mysql-cd8ae4ca****",
        "OrderId": "Order7230637470966354220"
    }
}

错误码

更多详情,请参见错误码