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

文档中心

立即注册

导航

CreateDrDBInstance

最近更新时间：2025.09.25 15:44:03首次发布时间：2025.01.22 12:03:55

调用 CreateDrDBInstance 接口为指定实例创建灾备实例。

请求类型

异步请求。

注意事项

该请求需发往灾备实例所在的地域。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
MasterInstanceId	String	是	mysql-cb50000b****	主实例的 ID。
MasterRegion	String	是	cn-shanghai	主实例所在的地域。
NodeInfo	Object[]	是	请参见请求示例。	灾备实例的规格。
StorageSpace	Integer	是	20	灾备实例的存储空间。每个规格对应的存储空间取值范围不同，关于存储空间取值范围的详细信息，请参见产品规格。单位为 GB，步长 10GB。
VpcId	String	是	vpc-3revrf005h5a85zsk2hlu****	私有网络（VPC） ID。可调用 DescribeVpcs 查询。说明不支持使用共享 VPC。
SubnetId	String	是	subnet-2bzpnnjy4b1ts2dx0efn9****	子网 ID。可调用 DescribeSubnets 通过指定 VpcId 和 ZoneId （主节点或备节点所在的可用区）查询可用的子网。
InstanceName	String	否	测试实例	实例名称。实例名称的命名规则如下：不能以数字、中划线开头。只能包含中文、字母、数字、下划线和中划线。长度限制在 1~128 之间。说明如不设定，则会以实例 ID 对实例进行命名。
DeletionProtection	String	否	Enabled	是否启用实例的删除保护功能。取值： `Enabled`：是。 `Disabled`：否。默认值。
ProxyNodeCustom	Object	否	请参见请求示例。	实例的数据库代理配置。说明当主实例为多节点实例时，该字段为必选。当主实例为双节点实例时，不支持进行数据库代理配置。
StorageType	String	否	LocalSSD	实例的存储类型。取值范围： `LocalSSD`：本地盘。 `CloudESSD_FlexPL`：FlexPL 云盘。 `CloudESSD_PL0`：PL0 云盘。说明如需设定 StorageSpace 参数，StorageType 参数为必传。当 InstanceType 取值为 `SingleNode` 时，StorageType 取值只能为 `CloudESSD_FlexPL` 或 `CloudESSD_PL0`。在不同接口中，该参数取值范围不同。具体规则如下：在以下接口中作为请求参数时，StorageType 的取值只能为 `LocalSSD`。 RestoreToCrossRegionInstance RestoreToNewInstanceFromUserTos 在部分接口中作为请求参数时，该参数的取值范围与原实例的存储类型有关，具体规则如下：原实例的存储类型为 `LocalSSD` 或 `CloudESSD_FlexPL` 时，不支持变更存储类型。原实例的存储类型为 `CloudESSD_PL0` 时，可取值为 `CloudESSD_PL0 或 CloudESSD_FlexPL`。涉及的接口是： RebuildDBInstance RestoreToNewInstance ModifyDBNodeSpec

返回参数

参数	类型	示例值	描述
InstanceId	String	mysql-9522449c****	创建的灾备实例的 ID。

示例

请求示例

POST /?Action=CreateDrDBInstance&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=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "MasterInstanceId": "mysql-cb50000b****",
    "MasterRegion": "cn-shanghai",
    "NodeInfo": [
        {
            "ZoneId": "cn-beijing-a",
            "NodeType": "Primary",
            "NodeSpec": "rds.mysql.d1.n.1c1g"
        },
        {
            "ZoneId": "cn-beijing-a",
            "NodeType": "Secondary",
            "NodeSpec": "rds.mysql.d1.n.1c1g"
        }
    ],
    "StorageSpace": 20,
    "VpcId": "vpc-3revrf005h5a85zsk2hlu****",
    "SubnetId": "subnet-2bzpnnjy4b1ts2dx0efn9****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20241205224453AFE647500FC978A40031-70c7af",
        "Action": "CreateDrDBInstance",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-guilin-boe"
    },
    "Result": {
        "InstanceId": "mysql-9522449c****"
    }
}

错误码

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