文档中心

云数据库 MySQL 版

实例管理

CreateDBBlueGreenInstance - 为实例创建蓝绿部署

CreateDBBlueGreenInstance - 为实例创建蓝绿部署

调用 CreateDBBlueGreenInstance 接口为实例创建蓝绿部署。

请求类型

异步请求。

注意事项

MySQL 8.4 版本的实例不支持创建蓝绿部署。

蓝色实例的运行状态需为运行中。

灾备实例不支持创建蓝绿部署。

实例已绑定蓝绿部署关系（即存在绿色实例）时，无法重复新建绿色实例。

调试

API Explorer

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

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-54fc7408****	蓝绿部署中蓝色实例的 ID。
DBEngineVersion	String	是	MySQL_8_0	绿色实例的兼容版本。取值： MySQL_5_7：MySQL 5.7 版本。 MySQL_8_0：MySQL 8.0 版本。
InstanceType	String	否	DoubleNode	绿色实例的实例类型。取值： DoubleNode，双节点类型。 MultiNode，多节点类型。 SingleNode，单节点类型。说明如蓝色实例的实例类型为单节点，可为绿色实例选择单节点或双节点的实例类型。如蓝色实例的实例类型为双节点，可为绿色实例选择双节点或多节点的实例类型。如蓝色实例的实例类型为多节点，只能为绿色实例选择多节点的实例类型。
NodeInfo	Array of NodeInfoObject	是	请参见请求示例。	蓝绿部署中绿色实例的规格配置。
StorageType	String	是	LocalSSD	实例的存储类型。取值范围： LocalSSD：本地盘。 CloudESSD_FlexPL：FlexPL 云盘。 CloudESSD_PL0：PL0 云盘。 CloudESSD_HighPerf：高性能云盘。说明如需设定 StorageSpace 参数，StorageType 参数为必传。当 InstanceType 取值为 SingleNode 时，StorageType 取值只能为 CloudESSD_FlexPL、CloudESSD_PL0 或 CloudESSD_HighPerf。在不同接口中，该参数取值范围不同。具体规则如下：在以下接口中作为请求参数时，StorageType 的取值只能为 LocalSSD。 RestoreToCrossRegionInstance RestoreToNewInstanceFromUserTos 在部分接口中作为请求参数时，该参数的取值范围与原实例的存储类型有关，具体规则如下：原实例的存储类型为 LocalSSD时，不支持变更存储类型。原实例的存储类型为 CloudESSD_PL0 时，可取值为 CloudESSD_PL0、 CloudESSD_FlexPL 或 CloudESSD_HighPerf。涉及的接口是： RebuildDBInstance RestoreToNewInstance ModifyDBNodeSpec
StorageSpace	Integer	是	100	蓝绿部署中绿色实例的存储空间。取值应不小于蓝色实例的存储空间。单位为 GiB。关于存储空间取值范围的详细信息，请参见产品规格。
InstanceName	String	否	测试实例-green	绿色实例名称。实例名称的命名规则如下：不能以数字、中划线开头。只能包含中文、字母、数字、下划线和中划线。长度限制在 1~128 之间。说明如果不设置绿色实例名称，默认会以${蓝色实例名}-green-${uuid6}的格式对绿色实例进行命名，并在超过 128 字符时截断。
ChargeInfo	Object of ChargeInfoObject	是	请参见请求示例。	蓝绿部署中绿色实例的计费配置。
DeletionProtection	String	否	Enabled	是否启用实例的删除保护功能。取值： Enabled：是。 Disabled：否。默认值。
DBParamGroupId	String	否	mysql-0cfb0b83d64a****	为蓝绿部署中绿色实例应用的参数模板 ID。说明如果蓝色实例和绿色实例的数据库兼容版本一致且不设置该参数时，则继承蓝色实例的参数配置。如果蓝色实例和绿色实例的数据库兼容版本不一，该参数必填。
MinorVersion	String	否	MySQL 5.7.32_20250615	蓝绿部署中绿色实例的内核小版本。可选择蓝色实例的内核小版本或最新的内核小版本。
SubnetId	String	否	subnet-3rf442t6a54w016nf3pg9****	子网 ID。说明如不设置，则使用与蓝色实例相同的子网。
ProxyNodeCustom	Object of ProxyNodeCustom	否	请参见请求示例。	蓝绿部署中绿色实例的代理核数。说明绿色实例代理功能的开启状态默认与蓝色实例保持一致。如蓝色实例的代理功能为开启，绿色实例代理核数默认与蓝色实例保持一致。在蓝色实例代理功能关闭的情况下，若将 CpuNum 参数的取值设置为大于 0，则绿色实例将强制开启代理功能，设置的值即为代理服务的 CPU 核数。在蓝色实例代理功能开启的情况下，若将 CpuNum参数的取值设置为 0，则绿色实例将强制关闭代理功能。
PrivateIpAddress	String	否	192.168.xxx.xxx	指定实例的默认终端在指定私有网络和子网下的 IP 地址。
AutoUpgradeMinorVersion	String	否	Auto	实例内核小版本的升级策略。取值： Auto：自动升级。当发布新的内核小版本时，实例将在设置的可维护时间段内，自动升级至最新的内核小版本。 Manual：手动升级。当发布新的内核小版本时，您需要在控制台手动至最新的内核小版本。具体操作，请参见手动升级实例内核小版本。说明若实例的内核小版本超出维护周期时，系统会暂时忽略内核小版本的升级策略设定，自动为实例升级内核小版本。

NodeInfoObject

参数	类型	是否必选	示例值	描述
NodeId	String	否	mysql-050b3e08****-r6e25	节点 ID。说明创建实例或新增节点时无需传入该参数，变更节点配置或删除节点时必传。
NodeType	String	是	Primary	节点类型，取值： Primary：主节点。 Secondary：备节点。 ReadOnly：只读节点。说明在查询实例价格详情接口（DescribeDBInstancePriceDetail）中，该字段为可选。在增加节点（CreateDBNodes）时，该字段取值只能为 ReadOnly（双节点实例）或 Secondary（多节点实例）。对于双节点实例，主节点和备节点有且只有 1 个，只读节点可选 0~10 个。对于多节点实例，主节点有且只有 1 个，最多可添加 8 个备节点，最少需有 1 个备节点。建议预留一个不承载业务的独立备节点，以便在必要时将其切换为主节点。若因未设置独立备节点致使所有备节点主备延迟过高，进而导致主节点切换失败，云数据库 MySQL 版不承担相关责任。
NodeSpec	String	是	rds.mysql.1c2g	节点规格。关于节点规格的详细信息，请参见产品规格。说明备节点的规格需与主节点的规格保持一致。只读节点规格可低于主节点的规格。但需注意，当只读节点规格低于主节点规格时，可能会因为主节点负载过高导致只读节点存在延迟甚至只读节点 OOM。建议为只读节点选择采与主节点相同或更高的规格。如 StorageType 取值为 CloudESSD_FlexPL 或 CloudESSD_PL0，NodeSpec 只能传入通用规格。
ZoneId	String	是	cn-beijing-a	节点所在可用区，可调用 DescribeAvailabilityZones 接口查询。在创建实例和新增节点时必传，变更节点配置或删除节点时可不传。说明一个实例的节点最多可分布在三个可用区。在一次变配中，最多可增删三个可用区下的节点。
NodeOperateType	String	否	Modify	操作类型。创建实例时无需传入该参数，修改节点配置时需要传入。取值范围： Create：增加节点。 Modify：修改节点配置。说明在增加节点（CreateDBNodes）时，该字段只能取值为 Create。在变更配置时，该字段只能取值为Modify。填写为 Delete时，该取值无实际意义。

ChargeInfoObject

参数	类型	是否必选	示例值	描述
ChargeType	String	是	PostPaid	付费类型。取值： PostPaid：按量付费（后付费）。 PrePaid：包年包月（预付费）。
AutoRenew	Boolean	否	true	预付费场景下是否到期自动续费。取值范围： true：到期自动续费。 false：到期不自动续费。说明 ChargeType 取值为 PrePaid 时，此参数必填。 ChargeType 取值为 PostPaid 时，不需要传入此参数。即使传入参数，系统也会自动忽略，配置不生效。
PeriodUnit	String	否	Month	预付费场景下的购买周期。取值范围： Month：购买周期为月。 Year：购买周期为年。说明 ChargeType 取值为 PrePaid 时，此参数必填。 ChargeType 取值为 PostPaid 时，不需要传入此参数。即使传入参数，系统也会自动忽略，配置不生效。
Period	Integer	否	1	预付费场景下的购买时长。该参数的取值范围取决于 PeriodUnit 的取值： PeriodUnit 取值为 Month 时，Period 的取值为 1~9。 PeriodUnit 取值为 Year 时，Period 的取值为 1~3。说明 ChargeType 取值为 PrePaid 时，此参数必填。 ChargeType 取值为 PostPaid 时，不需要传入此参数。即使传入参数，系统也会自动忽略，配置不生效。
Number	Integer	否	1	实例购买数量。取值范围为 1~50。默认值为 1。说明在 RestoreToNewInstance 与 RestoreToCrossRegionInstance 接口中，仅支持为该字段取值 1。不支持在批量创建实例时分别为实例指定名称。在批量创建实例时：如在 InstanceName 参数指定了实例名称，则会在指定的实例名称后加序号为批量创建的实例命名。如未在 InstanceName 参数指定实例名称，则会以实例 ID 为实例命名。

ProxyNodeCustom

参数	类型	是否必选	示例值	描述
CpuNum	Integer	否	4	实例数据库代理服务的 CPU 核数。取值如下：取值范围：上限 1024。对于多节点实例：推荐代理核数为实例所有可服务节点总 CPU 数0.25，结果向上取整。代理核数的取值下限为 2 与主节点 CPU 核数0.125之间的较大值。对于双节点实例：推荐代理核数为实例所有可服务节点总CPU数 * 0.5，结果向上取整。代理核数的取值下限为 2 与主节点 CPU 核数*0.5之间的较大值。

返回参数

参数	类型	示例值	描述
InstanceId	String	mysql-1252c254****	蓝绿部署中绿色实例的 ID。
OrderId	String	Order2180000035163379202	订单号。

示例

请求示例

返回示例

错误码

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

最近更新时间：2026.10.23 17:52:45

这个页面对您有帮助吗？

有用

有用

无用

无用