You need to enable JavaScript to run this app.
文档中心
云数据库 MySQL 版

云数据库 MySQL 版

复制全文
下载 pdf
实例管理
ModifyDBInstanceSpec - 修改实例配置
复制全文
下载 pdf
ModifyDBInstanceSpec - 修改实例配置
调用 ModifyDBInstanceSpec 接口修改实例配置。​
请求类型​
异步请求。​
注意事项​
该接口已弃用。请使用以下接口变更实例配置:​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
InstanceId​
String​
是​
mysql-e26822cf****​
实例 ID。​
NodeInfo​
Array of NodeInfoObject​
否​
[​
{​
"NodeId": "mysql-7d1efb9f****-0","NodeType": "Primary",​
"NodeSpec": "rds.mysql.1c2g",​
"NodeOperateType": "Modify"​
},​
{​
"NodeId": "mysql-7d1efb9f****-1",​
"NodeType": "Secondary",​
"NodeSpec": "rds.mysql.1c2g",​
"NodeOperateType": "Modify"​
},​
{​
"NodeId": "mysql-7d1efb9f****-r****",​
"NodeType": "ReadOnly",​
"NodeSpec": "rds.mysql.1c2g",​
"NodeOperateType": "Delete"​
},​
{​
"NodeType": "ReadOnly",​
"NodeSpec": "rds.mysql.1c2g",​
"NodeOperateType": "Create"​
},​
{​
"NodeId": "mysql-7d1efb9f****-r****",​
"NodeType": "ReadOnly",​
"NodeSpec": "rds.mysql.1c2g",​
"NodeOperateType": "Modify"​
}​
]​
实例规格配置。主节点和备节点有且只有 1 个,只读节点可选 0~10 个。除新增只读节点场景外,其他场景忽略 ZoneId。​
说明​
  • 该参数与 StorageSpace 二者必选其一,且这两个参数可同时修改。​
  • 云数据库 MySQL 版支持将主节点、备节点创建在不同可用区,但只读节点必须添加在主节点或备节点的可用区。​
ModifyType​
String​
否​
Usually​
实例规格的变更类型。取值为 Usually,常规变配。​
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​
StorageSpace​
Integer​
否​
100​
实例存储空间。取值范围:[20, 3000],单位为 GB,步长为 10GB。默认与当前值相同。​
说明​
该参数与 NodeInfo 二者必选其一,且这两个参数可同时修改。​
SwitchType​
String​
否​
MaintainTime​
执行时间,取值:​
  • Immediate:立即切换(默认)。​
  • MaintainTime:可维护时间段内进行切换。​
  • SpecifiedTime:指定时间段内进行切换。​
说明​
  • 取值为 SpecifiedTime 时,需要在参数 SpecifiedSwitchStartTime 和 SpecifiedSwitchEndTime 中设定时间段的起止时间。​
SpecifiedSwitchStartTime​
String​
否​
2024-12-25T14:00:00Z​
指定时间段执行时,时间段的起始时间。时间格式为 yyyy-MM-ddTHH:mm:ssZ。​
说明​
  • SwitchType 取值为 SpecifiedTime 时,该参数为必填参数。​
  • 任务执行的起始时间不得晚于当前日期后的第 7 日。​
SpecifiedSwitchEndTime​
String​
否​
2024-12-25T15:59:00Z​
指定时间段执行时,时间段的结束时间。时间格式为 yyyy-MM-ddTHH:mm:ssZ。​
说明​
  • SwitchType 取值为 SpecifiedTime 时,该参数为必填参数。​
  • 指定时间段的最短时长为一小时五十九分钟。​
  • 不支持跨天设置时间段,即任务执行的起始时间和结束时间不超过 24 小时。​
​
NodeInfoObject​
​
参数​
类型​
是否必选​
示例值​
描述​
NodeId​
String​
否​
mysql-050b3e08****-r6e25​
节点 ID。​
说明​
创建实例或新增节点时无需传入,变更节点配置或删除节点时必传。​
NodeType​
String​
是​
Primary​
节点类型,取值:​
  • Primary:主节点。​
  • Secondary:备节点。​
  • ReadOnly:只读节点。​
NodeSpec​
String​
是​
rds.mysql.1c2g​
节点规格。关于节点规格的详细信息,请参见产品规格。​
说明​
  • 备节点的规格需与主节点的规格保持一致。​
  • 只读节点规格可低于主节点的规格。但需注意,当只读节点规格低于主节点规格时,可能会因为主节点负载过高导致只读节点存在延迟甚至只读节点 OOM。建议为只读节点选择采与主节点相同或更高的规格。​
  • 如 StorageType 取值为 CloudESSD_FlexPL 或 CloudESSD_PL0,NodeSpec 只能传入通用规格。​
ZoneId​
String​
是​
cn-beijing-a​
节点所在可用区,可调用 DescribeAvailabilityZones 接口查询。在创建实例和新增节点时必传,变更节点配置或删除节点时可不传。​
说明​
  • 一个实例的节点最多可分布在三个可用区。​
  • 在一次变配中,最多可增删三个可用区下的节点。​
NodeOperateType​
String​
否​
Modify​
操作类型。创建实例时无需传入,修改节点配置时需要传入。取值范围:​
  • Create:增加。​
  • Modify:修改。​
  • Delete:删除。​
​
返回参数​
​
参数​
类型​
示例值​
描述​
InstanceId​
String​
mysql-7d1efb9f****​
实例 ID。​
OrderId​
String​
Order71220115095297****​
订单 ID。​
​
示例​
请求示例​
​
POST /?Action=ModifyDBInstanceSpec&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****​
{​
"InstanceId": "mysql-f4cba23f****",​
"NodeInfo": [​
{​
"NodeId": "mysql-f4cba23f****-0",​
"NodeType": "Primary",​
"NodeSpec": "rds.mysql.2c4g",​
"NodeOperateType": "Modify"​
},​
{​
"NodeId": "mysql-f4cba23f****-1",​
"NodeType": "Secondary",​
"NodeSpec": "rds.mysql.2c4g",​
"NodeOperateType": "Modify"​
},​
{​
"ZoneId": "cn-beijing-a",​
"NodeType": "ReadOnly",​
"NodeSpec": "rds.mysql.2c4g",​
"NodeOperateType": "Create"​
}​
],​
"StorageType": "LocalSSD",​
"StorageSpace": 200​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20220719173634010212035227001977AC",​
"Action": "ModifyDBInstanceSpec",​
"Version": "2022-01-01",​
"Service": "rds_mysql",​
"Region": "cn-beijing"​
},​
"Result": {​
"InstanceId": "mysql-f4cba23f****",​
"OrderId": "Order71220115095297****"​
}​
}​
​
错误码​
更多详情,请参见错误码。​
​
最近更新时间:2026.06.10 10:58:16
这个页面对您有帮助吗?
有用
有用
无用
无用