调用 RestoreToCrossRegionInstance 接口将跨地域备份恢复到一个新实例。
异步请求。
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| DstRegionId | String | 是 | cn-beijing | 需设定为跨地域备份所在的地域。可调用 DescribeBackups 接口通过指定 BackupID 查询。 |
| SrcRegionId | String | 是 | cn-shanghai | 原实例所在地域的 ID。 |
| SrcRegionInstanceId | String | 是 | mysql-f570c97b**** | 备份所属的实例的 ID。 |
BackupId | String | 否 | 84399659f869433296e8aa69ef42**** | 备份文件的 ID。通过调用 DescribeBackups 可查询 BackupID。 说明 该参数与 RestoreTime 参数二者必选其一。 |
RestoreTime | String | 否 | 2022-01-01T10:10:10Z | 原实例备份保留周期内的任意时间点，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。通过调用 DescribeRecoverableTime 可查询该时间点是否支持还原。 说明 该参数与 RestoreTime 参数二者必选其一。 |
| NodeInfo | Array of NodeInfoObject | 是 | 请参见请求示例。 | 实例规格配置。主节点和备节点有且只有 1 个，只读节点可选 0~10个。更多关于 NodeInfo 信息，请参见数据结构。 |
| StorageType | String | 是 | LocalSSD | 实例存储类型。取值为 LocalSSD，本地 SSD 盘。 |
| StorageSpace | Integer | 否 | 100 | 实例存储空间。取值范围：[原实例存储空间大小, 3000]，单位为 GB，步长为 10GB。默认值为原实例空间大小。 |
| VpcId | String | 是 | vpc-2d70di2hrnbpc58ozfdx9**** | 专有网络（VPC） ID。可调用 DescribeVpcs 查询。 |
| SubnetId | String | 是 | subnet-2d70dj20bob9c58ozfek6**** | 子网 ID。可调用 DescribeSubnets 通过指定 VpcId 和 ZoneId （主节点或备节点所在的可用区）查询可用的子网。 |
InstanceName | String | 否 | 实例样例 | 实例名称。实例名称的命名规则如下：
|
| ProjectName | String | 否 | Test | 实例所属的项目。如需在创建时指定项目，需确保项目已存在。可通过调用 ListProjects 接口查询项目列表，也可通过调用 CreateProject 接口创建新的项目。 |
| AllowListIds | Array of String | 否 | ["acl-b8af53a30f4c46cfb5d2435950a2****","acl-8a007bb775244b70b3d20e328010****"] | 白名单 ID。如需绑定多个白名单，白名单 ID 用英文逗号（,）分隔。一个实例最多可绑定 100 个白名单。 |
| ChargeInfo | ChargeInfoObject | 是 | { "ChargeType": "PostPaid" } | 付费方式。更多关于 ChargeInfo 信息，请参见数据结构。 |
| DBParamGroupId | String | 否 | 参数模板 ID。默认值为数据库引擎版本对应的默认参数模板。 | |
| InstanceTags | Array of TagObject | 否 | [{"Key":"tag_key", "Value": "tag_value"}] | 实例标签。更多关于 InstanceTags 信息，请参见数据结构。 |
Port | Integer | 否 | 3306 | 默认终端的私网端口。端口号的取值范围为 1000~65534，默认值为 3306。 说明 创建新的连接终端或开启新地址时，将使用默认终端的私网端口实时配置为默认端口。 |
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| InstanceId | String | mysql-16f93185**** | 实例 ID。 |
| OrderId | String | Order736063447161464**** | 订单 ID。 |
POST /?Action=RestoreToCrossRegionInstance&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-shanghai/rds_mysql/request, SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645a**** { "SrcRegionInstanceId": "mysql-f570c97b****", "SrcRegionId": "cn-beijing", "DstRegionId": "cn-shanghai", "BackupId": "84399659f869433296e8aa69ef42****", "NodeInfo": [ { "ZoneId": "cn-shanghai-a", "NodeSpec": "rds.mysql.1c2g", "NodeType": "Primary" }, { "ZoneId": "cn-shanghai-a", "NodeSpec": "rds.mysql.1c2g", "NodeType": "Secondary" } ], "VpcId": "vpc-2d70di2hrnbpc58ozfdx9****", "SubnetId": "subnet-2d70dj20bob9c58ozfek6****", "ChargeInfo": { "ChargeType": "PostPaid" } }
{ "ResponseMetadata": { "RequestId": "2024042218213714999C900FF9E0B97D5A-b9383e", "Action": "RestoreToCrossRegionInstance", "Version": "2022-01-01", "Service": "rds_mysql", "Region": "cn-shanghai" }, "Result": { "InstanceId": "mysql-f2f3bd1f****", "OrderId": "Order736063447161464****" } }
更多详情，请参见错误码。