RebuildDBInstance--云数据库 MySQL 版-火山引擎

文档中心

立即注册

导航

RebuildDBInstance

最近更新时间：2025.06.09 14:25:48首次发布时间：2023.08.14 13:15:55

调用 RebuildDBInstance 接口通过已删除实例备份重建实例。

请求类型

异步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-0f1a2a9a****	实例 ID。
ProjectName	String	否	default	实例所属项目名称。说明如不设置，重建的实例将被归属至默认项目，即取 `default` 值。
RequestSource	String	否	EventType_Web	请求来源。取值： `EventType_Web`：来自 Web。 `EventType_OpenAPI`：来自 Open API。
BackupId	String	否	2b18d7e970c442caae05be478a9e****	备份文件 ID。
StorageType	String	否	LocalSSD	实例存储类型。取值为 `LocalSSD`，表示本地 SSD 盘。说明如需设定 StorageSpace 参数，StorageType 参数为必传。
StorageSpace	Integer	否	100	实例存储空间。取值范围：[原实例存储空间大小, 新实例主节点规格对应可选择存储空间范围的上限]，单位为 GB，步长为 10GB。默认值为原实例空间大小。说明每个规格对应的存储空间取值范围不同，关于存储空间取值范围的详细信息，请参见产品规格。
VpcId	String	否	vpc-2d70di2hrnbpc58ozfdx9****	私有网络（VPC） ID。可调用 DescribeVpcs 查询。说明不支持使用共享 VPC。
InstanceName	String	否	TestInstance	实例名称。实例名称的命名规则如下：不能以数字、中划线开头。只能包含中文、字母、数字、下划线和中划线。长度限制在 1~128 之间。说明如不设定，则会以原实例 ID 对重建实例进行命名。
DBParamGroupId	String	否	mysql-sys-6013c7b8f7ef****	参数模板 ID。默认值为数据库引擎版本对应的默认参数模板。
ChargeInfo	Object	否	请参见请求示例。	付费方式。
NodeInfo	Object[]	否	请参见请求示例。	实例规格配置。主节点和备节点有且只有 1 个，只读节点可选 0~10 个。
SubnetId	String	否	subnet-2d70dj20bob9c58ozfek6****	子网 ID。可调用 DescribeSubnets 通过指定 VpcId 和 ZoneId （主节点或备节点所在的可用区）查询可用的子网。
InstanceTags	Object[]	否	请参见请求示例。	实例标签。每个 MySQL 实例最多可绑定 50 个标签。单次操作中最多可添加 20 个标签。
AllowListIds	String[]	否	[ "acl-a29be2559dc4406883d358892b90**", "acl-ded4c0b707e44efd8f0dbc4e88f5**" ]	白名单 ID。如需绑定多个白名单，白名单 ID 用英文逗号（,）分隔。一个实例最多可绑定 100 个白名单。说明通过 RebuildDBInstance 接口恢复到新实例时默认不会绑定源实例的白名单。您可以在重建实例完成后，通过调用 AssociateAllowList 接口绑定白名单到新实例。
Port	Integer	否	3307	默认终端的私网端口。端口号的取值范围为 1000~65534，默认值为 3306。创建新的连接终端或开启新地址时，将使用默认终端的私网端口实时配置为默认端口。
AutoStorageScalingConfig	Object	否	请参见请求示例。	自动扩容配置。
DeletionProtection	String	否	Enabled	是否启用实例的删除保护功能。取值： `Enabled`：是。 `Disabled`：否。默认值。

返回参数

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

示例

请求示例

POST /?Action=RebuildDBInstance&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mysql.cn-beijing.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlk****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c****
{
    "InstanceId": "mysql-05aeaf44fe2f",
    "BackupId": "34c5f835570c4eab85ed5ecb4f583820",
    "NodeInfo": [
        {
            "NodeType": "Primary",
            "ZoneId": "cn-beijing-a",
            "NodeSpec": "rds.mysql.1c2g"
        },
        {
            "NodeType": "Secondary",
            "ZoneId": "cn-beijing-a",
            "NodeSpec": "rds.mysql.1c2g"
        }
    ],
    "StorageType": "LocalSSD",
    "StorageSpace": 110,
    "AutoStorageScalingConfig": {
        "EnableStorageAutoScale": true,
        "StorageThreshold": 20,
        "StorageUpperBound": 300
    },
    "InstanceTags": [
        {
            "Key": "key1",
            "Value": "value1"
        },
        {
            "Key": "key2",
            "Value": "value2"
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023080920015509344927A18EDA8CBB20",
        "Action": "RebuildDBInstance",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstanceId": "mysql-0f1a2a9a****",
        "OrderId": "Order726528840890330****"
    }
}

错误码

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