You need to enable JavaScript to run this app.
导航
云数据库 MySQL 版
  • 文档首页
    • /
  • 云数据库 MySQL 版

RestoreToNewInstance

最近更新时间：2024.04.26 10:36:48

首次发布时间：2023.02.02 17:41:22

我的收藏

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

请求类型

异步请求。

请求参数

名称类型是否必选示例值描述
SrcInstanceIdString是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

Array of NodeInfoObject

是

[
{
"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 个。更多关于 NodeInfo 信息，请参见数据结构。

StorageTypeString是LocalSSD实例存储类型。取值为 LocalSSD，本地 SSD 盘。
StorageSpaceInteger否100实例存储空间。取值范围：[20, 3000]，单位为 GB，步长为 10GB。默认值为原实例空间大小。
VpcIdString是VPC123456专有网络（VPC） ID。可调用 DescribeVpcs 查询，使用此参数指定要创建实例的 VPC。
SubnetIdString是Subnet123456子网 ID。

AllowListIds

Array of String

否

[
"acl-a29be2559dc4406883d358892b90****",
"acl-ded4c0b707e44efd8f0dbc4e88f5****"
]

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

说明

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

InstanceName

String

否

Name123

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

  • 不能以数字、中划线开头。
  • 只能包含中文、字母、数字、下划线和中划线。
  • 长度限制在 1~128 之间。
DBParamGroupIdString否mysql-sys-6013c7b8f7ef****参数模板 ID。默认值为数据库引擎版本对应的默认参数模板。
ProjectNameString否Test所属项目。

ChargeInfo

ChargeInfoObject

是

{
"ChargeType": "PostPaid"
}

付费方式。更多关于 ChargeInfo 信息，请参见数据结构。

InstanceTags

Array of TagObject

否

[
{
"Key":"key1",
"Value":"value1"
},
{
"Key":"key2",
"Value":"value2"
}
]

实例标签。更多关于 InstanceTags 信息，请参见数据结构。

返回参数

名称类型示例值描述
InstanceIdStringmysql-e7fda57b****恢复的新实例的实例 ID。
OrderIdStringOrder709899242175681****订单 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=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645a****

{
    "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****"],
    "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"
    }
}

错误码

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