调用 DescribeDBInstanceHAConfig 接口查询实例的高可用配置。

请求类型

同步请求。

调试

API Explorer

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

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-f83edc2e****	实例 ID。

返回参数

参数	类型	示例值	描述
Nodes	Array of NodeDetailInfoObject	请参见返回示例。	实例的节点信息。
DataSyncMode	String	Async	数据同步方式： SemiSync：半同步。 Async：异步。
AutoStorageScalingConfig	Object of AutoStorageScalingConfig	请参见返回示例。	存储空间的自动扩缩容规则。
AutoSpecScalingConfig	Object of AutoSpecScalingConfig	请参见返回示例	节点规格的扩缩容规则。

NodeDetailInfoObject

参数	类型	示例值	描述
CreateTime	String	2024-10-29T08:45:28.000Z	节点的创建时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ss.sssZ。
DelayReplicationTime	Long	1000	只读节点的延迟复制时间，取值为 0~604800，单位为秒。
InstanceId	String	mysql-h441603c****	实例 ID。
Memory	Integer	2	内存大小，单位为 GiB。
NodeId	String	mysql-h441603c****-01	节点 ID。
NodeSpec	String	rds.mysql.d1.n.2c4g	节点规格。关于节点规格的详细信息，请参见产品规格。
NodeStatus	String	Running	节点状态，取值： Running：运行中。 Creating：创建中。 Deleting：删除中。 Restarting：重启中。 Restoring：恢复中。 Updating：变更中。 Upgrading：升级中。 Error：错误。
NodeType	String	Primary	节点类型。取值： Primary：主节点。 Secondary：备节点。 ReadOnly：只读节点。
RegionId	String	cn-beijing	地域 ID，可调用 DescribeRegions 查询，使用此参数指定要创建实例的地域。
SyncDelay	Long	28	节点与主节点之间的延迟时间。单位为毫秒（ms）。
UpdateTime	String	2024-10-31T08:45:28.000Z	节点更新本地时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ss.sssZ。
VCPU	Integer	1	节点的 CPU 核数。
ZoneId	String	cn-beijing-a	可用区 ID。

AutoStorageScalingConfig

参数	类型	示例值	描述
EnableStorageAutoScale	Boolean	true	是否开启存储空间的自动扩容功能。取值： true：是。 false：否。说明 StorageConfig 作为请求参数时，如 EnableStorageAutoScale取值为 false，可不传入 StorageThreshold 和 StorageUpperBound 参数。
StorageThreshold	Integer	20	触发自动扩容的可用存储空间占比。取值范围为 10~50，默认值为 10，单位为 %。
StorageUpperBound	Integer	3000	可自动扩容的存储空间上限。该字段的取值下限为实例存储空间+20 GiB；取值上限为实例主节点规格对应的存储空间取值范围的上限，单位为 GiB。关于不同规格可选择存储空间取值范围的详细信息，请参见产品规格。
ScalingDetectNode	String	MasterNode	检测是否需进行自动扩容的节点范围。取值： MasterNode：主节点。 MasterSlaveNodes：主备节点。 AllNodes：所有节点。说明该参数作为请求参数时，默认值为 MasterNode。对于多节点实例，该参数取值为 MasterSlaveNodes 和 AllNodes 的效果相同。对于单节点实例，该参数取值为 MasterNode、MasterSlaveNodes 和 AllNodes 的效果相同。

AutoSpecScalingConfig

参数	类型	示例值	描述
LatestExpandTime	String	2026-07-25T06:25:22Z	实例最近触发扩缩容的时间。格式为 yyyy-MM-dd HH:mm:ss（UTC 时间）。说明若实例未触发扩缩容，则不返回该参数。
CronAutoScalingSpecRules	Array of CronAutoScalingSpecRule	请参见返回结果	定时扩缩容规则。
SupportCloudDiskAutoScaling	Boolean	true	是否支持云盘实例自动扩缩容。取值： true：支持。 false：不支持。
ExpandObservableAutoScalingSpecRules	Array of ExpandObservableAutoScalingSpecRule	请参见返回示例	自动扩容规则。
ReduceObservableAutoScalingSpecRules	Array of ReduceObservableAutoScalingSpecRule	请参见返回示例	自动缩容规则。

CronAutoScalingSpecRule

参数	类型	示例值	描述
RuleId	String	rule-6311830b433****	定时扩缩容规则 ID。
Enabled	Boolean	true	是否启用该规则。取值： true：启用。 false：关闭。
ExpandTime	Object of CycleTimeInfo	请参见返回示例	扩容操作开始的时间。
ReduceTime	Object of CycleTimeInfo	请参见返回示例	缩容操作开始的时间。
CyclePeriod	String	Once	扩缩容执行的周期。取值： Once：扩缩容只在指定的扩容开始时间和缩容时间触发一次。 ByDay：扩缩容将每天在指定的扩容开始时间和缩容时间自动触发。 ByWeek：扩缩容将每周在指定的扩容开始时间和缩容时间自动触发。 ByMonth：扩缩容将每月在指定的扩容开始时间和缩容时间自动触发。
RuleEndTime	String	2026-07-31T00:00:00.000Z	定时扩缩容规则的生效结束时间，格式为 yyyy-MM-dd HH:mm:ss（UTC 时间）。说明仅 CyclePeriod 参数的取值为 ByDay、ByWeek 和 ByMonth 时返回该参数。
NodeIdsToSpec	JSON Map	{ "mysql-8b56e2f0**-m*-0": "rds.mysql.c.s.2c4g", "mysql-8b56e2f0-r": "rds.mysql.c.s.2c4g"， "mysql-8b56e2f0*-s***-0": "rds.mysql.c.s.2c4g" }	待扩容和缩容的节点 ID 及扩容的目标规格，格式为 JSON。说明到达缩容操作开始时间后，系统自动将实例缩容至原规格。
RuleBeginTime	String	2026-07-23T00:00:00.000Z	定时扩缩容规则的生效开始时间，格式为 yyyy-MM-dd HH:mm:ss（UTC 时间）。说明仅 CyclePeriod 参数的取值为 ByDay、ByWeek 和 ByMonth 时返回该参数。
NodeIdsToOriginalSpec	JSON Map	{ "mysql-8b56e2f0**-m-0": "rds.mysql.c.s.1c2g", "mysql-8b56e2f0-r": "rds.mysql.c.s.1c2g", "mysql-8b56e2f0-s**-0": "rds.mysql.c.s.1c2g" }	实例的各节点 ID 以及节点的原规格，格式为 JSON 。说明到达缩容操作开始时间后，系统自动将实例缩容至原规格。

CycleTimeInfo

参数	类型	示例值	描述
OnceTime	String	2026-07-23T13:03:00.000Z	扩容操作触发的时间，格式为 yyyy-MM-dd HH:mm:ss（UTC 时间）。说明仅 CyclePeriod 参数的取值为 Once 时返回该参数。
DayOfWeek	Integer	1	扩缩容操作执行的周期，星期取值范围 0～6，其中 0 代表星期日。说明仅 CyclePeriod 参数的取值为 ByWeek 时返回该参数。
TimeOfDay	Integer	3600	扩容和缩容操作的触发的时间。格式为 1-24*3600，单位为秒。
DayOfMonth	Integer	10	扩缩容操作执行的周期，每月第几天，取值范围 1~31。说明仅 CyclePeriod 参数的取值为 ByMonth 时返回该参数。

ExpandObservableAutoScalingSpecRule

参数	类型	示例值	描述
RuleId	String	rule-b3b22c3c9xxxx	自动扩容的规则 ID。
Enabled	Boolean	true	是否启用自动扩容规则。取值如下： true：启用。 false：关闭。
RuleType	String	PrimaryAndSecondary	自动扩容规则类型。取值如下： PrimaryAndSecondary：仅为主备节点配置扩缩容规则。 AllReadOnlyNodes：为所有只读节点配置扩缩容规则。
StopToSpec	String	rds.mysql.c.s.1c2g	扩容操作的目标节点规格。
ExcludeNodeIds	Array of String	mysql-8b56e2fxxxx-rxxxx	不检测和不触发自动扩容的只读节点 ID。
TriggerThreshold	Integer	90	触发扩容操作时的CPU 的平均使用率。取值范围为 [50~90]。
ObservationTimeDuration	Integer	300	触发扩容操作时，CPU 的平均使用率超过阈值的持续时间。单位为秒。取值如下： 300 600 1200 1800 2400 3600

ReduceObservableAutoScalingSpecRule

参数	类型	示例值	描述
RuleId	String	rule-b3b22c3c9xxxx	自动缩容的规则 ID。
Enabled	Boolean	true	是否启用自动缩容规则。取值如下： true：启用。 false：关闭。
RuleType	String	PrimaryAndSecondary	自动缩容规则类型。取值如下： PrimaryAndSecondary：仅为主备节点配置扩缩容规则。 AllReadOnlyNodes：为所有只读节点配置扩缩容规则。
StopToSpec	String	rds.mysql.c.s.1c2g	缩容操作的目标节点规格。
ExcludeNodeIds	Array of String	mysql-8b56e2fxxxx-rxxxx	不检测和不触发自动缩容的只读节点 ID。
TriggerThreshold	Integer	90	触发缩容操作时的CPU 的平均使用率。取值范围为 [5~30]。
ObservationTimeDuration	Integer	300	触发缩容操作时，CPU 的平均使用率超过阈值的持续时间。单位为秒。取值如下： 300 600 1800 3600 7200 10800 86400 604800

示例

请求示例

返回示例

错误码

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

云数据库 MySQL 版