调用 DescribeDBInstanceDetail 接口查看实例详情。

请求类型

同步请求。

注意事项

该接口已弃用。请使用以下接口查询实例的各项信息：

DescribeDBInstanceAttribute：调用 DescribeDBInstanceAttribute 接口查询实例的属性。

DescribeDBInstanceEndpoints：调用 DescribeDBInstanceEndpoints 接口查询实例的连接地址列表。

DescribeResourceUsage：调用 DescribeResourceUsage 接口查询实例的资源使用情况。

DescribeDBInstanceChargeDetail：调用 DescribeDBInstanceChargeDetail 接口查询实例的计费信息。

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

DescribeDBDisasterRecoveryInstances：调用 DescribeDBDisasterRecoveryInstances 接口查询实例的灾备实例信息。

DescribeDBProxy：调用 DescribeDBProxy 接口查询实例的代理配置。

调试

API Explorer

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

去调试

请求参数

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

返回参数

参数	类型	示例值	描述
BasicInfo	Object of BasicInfoObject	请参见返回示例。	实例基本信息。
ChargeDetail	Object of ChargeDetailObject	请参见返回示例。	付费方式。
Endpoints	Array of EndpointObject	请参见返回示例。	实例的连接信息。
Nodes	Array of NodeObject	请参见返回示例。	实例节点信息。
ProxyDetail	Object of ProxyInfoObject	请参见返回示例。	实例数据库代理服务的配置信息。
DisasterRecoveryInstances	Array of DisasterRecoveryInstance	请参见返回示例。	灾备实例中灾备实例的信息。说明主实例会返回该字段。

BasicInfoObject

参数	类型	示例值	描述
AllowListVersion	String	V2	白名单版本。
AutoUpgradeMinorVersion	String	Auto	实例内核小版本的升级策略。取值： Auto：自动升级。 Manual：手动升级。
CreateTime	String	2022-01-01T10:10:10Z	实例创建本地时间。
CurrentKernelVersion	String	MySQL 8.0.32_20240415	实例的内核小版本。
DBEngineVersion	String	MySQL_8_0	兼容版本。取值： MySQL_5_7：MySQL 5.7 版本。 MySQL_8_0：MySQL 8.0 版本。 MySQL 8.4：MySQL 8.4 版本。
DataSyncMode	String	Async	数据同步方式： SemiSync：半同步。 Async：异步。
DeletionProtection	String	Enabled	是否启用实例的删除保护功能。取值： Enabled：是。 Disabled：否。默认值。
InstanceId	String	mysql-66347599****	实例 ID。
InstanceName	String	测试实例	实例名称。
InstanceStatus	String	Running	实例状态，取值： Creating：创建中。 Running：运行中。 Deleting：删除中。 Restarting：重启中。 Updating：变更中。 Restoring：恢复中。 Error：错误。 Upgrading：升级中。 Released：回收中。 Recycled：已回收。 MasterChanging：主节点切换中。 TDEUpdating：TDE 修改中。 Closed：关停。 Maintaining：维护中。 CreateFailed：创建失败。 Closing：关停中。 SSLUpdating：SSL 变更中。 AllowListMaintaining：白名单变更中。 Unknown：未知。 ProxyCreating：代理开启中。 ProxyDeleting：代理关闭中。 ChargeTypeChanging：计费类型变更中。 NetWorkChanging：网络变更中。
InstanceType	String	DoubleNode	实例类型。取值： DoubleNode，双节点类型。 MultiNode，多节点类型。
LowerCaseTableNames	String	true	表名是否区分大小写，默认取值为 true。取值： false：表名被存储成固定且表名称大小写敏感。 true：表名将被存储成小写且表名称大小写不敏感。
MaintenanceWindow	Object of MaintenanceWindowObject	请参见示例。	在创建实例时指定实例的可维护时间段。该字段为可选，不设置时默认为一周内每一天的 UTC18:00Z-21:59Z（即北京时间 02:00-05:59）。
Memory	Integer	2	内存大小。单位：GiB。
NodeNumber	String	2	节点数量。
NodeSpec	String	rds.mysql.1c2g	节点规格。关于节点规格的详细信息，请参见产品规格。
ProjectName	String	Test	所属项目。
RegionId	String	cn-beijing	地域 ID，可调用 DescribeRegions 查询，使用此参数指定要创建实例的地域。
StorageSpace	Long	200	实例总存储空间。单位：GiB。
StorageType	String	LocalSSD	实例存储类型。取值为 LocalSSD，即本地 SSD 盘。
StorageUse	Double	4.14	实例已用储空间。单位：GiB。
SubnetId	String	subnet-3rf442t6a54w016nf3pg9****	子网 ID。
Tags	Array of TagObject	请参见示例。	绑定的标签键和标签值数组对象。说明作为返回参数时，仅在实例绑定的有标签时返回。
TimeZone	String	UTC + 08：00	时区
UpdateTime	String	2022-01-01T10:10:10Z	实例更新本地时间。
VCPU	Integer	1	CPU 大小。例如：1 表示 1U。
VpcId	String	vpc-3rebt5uf5fr405zsk2if9****	专有网络（VPC） ID。
ZoneId	String	cn-beijing-a	可用区 ID。
DrDtsTaskId	String	df5a93434880466cb8422b2db93d****	主实例与灾备实例之间的数据同步链路在 DTS 数据同步任务的 ID。
MasterRegion	String	cn-shanghai	灾备实例的主实例所在的地域。
DrDtsTaskName	String	灾备实例测试链路	主实例与灾备实例之间的数据同步链路在 DTS 数据同步任务的名称。
DrDtsTaskStatus	String	Running	主实例与灾备实例之间的数据同步链路在 DTS 数据同步任务的状态。
MasterInstanceId	String	mysql-ce48081d****	灾备实例的主实例的 ID。
MasterInstanceName	String	灾备实例主实例	灾备实例的主实例的名称。
DrSecondsBehindMaster	Integer	1	灾备实例与主实例之间的数据同步时延。
EngineType	String	RocksDB	数据库引擎类型。取值： InnoDB：InnoDB 引擎。 RocksDB：RocksDB 引擎。说明作为请求参数时，默认值为 InnoDB。
NewNodeSpec	String		通用实例规格，新规格码 rds.mysql.d1.xxcxxg

MaintenanceWindowObject

参数	类型	示例值	描述
DayKind	String	Week	可维护周期粒度，取值为 Week，周。
DayOfWeek	Array of String	["Monday","Tuesday"]	指定修改每周哪一天的可维护时间段，取值为：Monday，Tuesday，Wednesday，Thursday，Friday，Saturday，Sunday，可多选。如果不指定该值或者为空，则默认一周七天都指定。
MaintenanceTime	String	22:00Z-02:00Z	实例的可维护时间段。格式：HH:mmZ-HH:mmZ（UTC 时间）。

TagObject

参数	类型	示例值	描述
Key	String	tagkey	实例标签的标签键。标签键的设置规则如下：支持任何语言字母或文字（如中文、英文字母等）、数字、空格。支持特殊字符：_.:/=+-@。 volc: 为系统预留的标签键，添加标签时，标签键的开头不能设置为任何大小写形式的 volc:。标签键的长度需为 1~128 个字符。
Value	String	tagvalue	实例标签的标签值。标签值的设置规则如下：支持任何语言字母或文字（如中文、英文字母等）、数字、空格。支持特殊字符：_.:/=+-@。标签值的长度需为 0~256 个字符，即标签值可以为空。

ChargeDetailObject

参数	类型	示例值	描述
AutoRenew	Boolean	true	预付费场景下是否自动续费。 true：到期自动续费。 false：到期不自动续费。
ChargeEndTime	String	2025-08-22T15:59:59.000Z	包年包月实例的计费结束时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ss.sssZ。说明如查询的是按量计费实例，该字段返回为空。
ChargeStartTime	String	2025-07-22T13:10:15.000Z	实例的计费开始时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ss.sssZ。
ChargeStatus	String	Normal	实例的计费状态。取值： Normal：正常。 Overdue：欠费。 Unpaid：等待支付。
ChargeType	String	PostPaid	付费类型。取值： PostPaid：按量付费（后付费）。 PrePaid：包年包月（预付费）。
OverdueReclaimTime	String	2025-08-29T15:59:59.000Z	实例欠费关停（按量付费）或到期关停（包年包月）后，预计被释放的时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ss.sssZ。
OverdueTime	String	2025-08-23T04:00:00.000Z	实例欠费关停（按量付费）或到期关停（包年包月）的时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ss.sssZ。
Period	Integer	1	预付费场景下的购买时长。说明该参数作为请求参数时，默认值为 1。当 PeriodUnit 的取值为 Year 时，Period 的取值范围为 1~3。当 PeriodUnit 的取值为 Month 时，Period 的取值范围为 1~9。
PeriodUnit	String	Month	预付费场景下的购买周期。 Month：购买周期为月。 Year：购买周期为年。说明该参数作为请求参数时，默认值为 Month。
TempModifyStartTime	String	2022-01-01T10:10:10.000Z	临时升配的开始时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ss.sssZ。说明未处于临时升配期的实例，不返回该字段。
TempModifyEndTime	String	2022-01-01T10:10:09.000Z	临时升配的还原时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ss.sssZ。说明未处于临时升配期的实例，不返回该字段。

EndpointObject

参数	类型	示例值	描述
Addresses	Array of AddressObject	请参见返回示例。	地址列表。
AutoAddNewNodes	String	Enable	当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值： Enable：自动加入 Disable：不自动加入（默认）。
ConnectionInfoTags	Array of String	["Default"]	连接终端标签。
ConnectionMode	String	Proxy	连接终端类型。取值： Proxy：代理终端。 Direct：直连终端。说明如实例的数据库代理功能已开启，可以取值为 Proxy 或 Direct。如实例的数据库代理功能未开启，仅可以取值为 Direct。可调用 DescribeDBInstanceDetail 接口查询实例数据库代理功能的开启状态。
ConnectionPoolType	String	Direct	代理终端的连接池类型。取值： Transaction：事务级连接池。默认值。 Direct：直连模式。
Description	String	这是一段连接终端的描述信息。	连接终端的描述信息。
EnableReadOnly	String	Enable	是否已开启全局只读，取值： Enable：开启。 Disable：未开启。
EnableReadWriteSplitting	String	Enable	是否已开启读写分离，取值： Enable：开启。 Disable：未开启。
EnableConnectionPersistent	Boolean	false	是否启用连接保持。取值： true：是。 false：否。
EndpointId	String	mysql-050b3e08****	实例连接终端 ID。
EndpointName	String	自定义连接终端	实例连接终端名称。
EndpointType	String	Custom	终端类型。取值为 Custom，自定义终端。
IdleConnectionReclaim	Boolean	true	空闲连接回收功能是否开启。 true：开启。 false：不开启。说明仅代理终端会返回该字段。
ImplicitTransSplit	Boolean	false	是否开启事务分离。取值： true：是。 false：否。说明仅代理终端会返回该字段。
MasterNodeRouting	Boolean	false	是否开启主节点路由。取值： true：是。 false：否。说明仅代理终端会返回该字段。
MasterProtectorTimeout	Integer	60	过载保护超时时间。取值范围为 60~7200 之间的整数，单位为秒。说明仅代理终端会返回该字段。
MultiStatementsMode	String	Loose	代理终端的 Multi-Statements 模式。取值： Strict：Strict 模式。默认值。 Loose：Loose 模式。
OverloadProtection	Boolean	false	是否开启过载保护。取值： true：是。 false：否。说明仅代理终端会返回该字段。
ReadOnlyNodeDistributionType	String	LoadSchedule	读权重分配模式。当开通读写分离设置为 true 时需要传入此参数。在 CreateDBEndpoint 和 ModifyDBEndpoint 接口中做请求参数时，取值范围如下： LoadSchedule：负载调度。 RoundRobinCustom：自定义权重的轮询调度。 RoundRobinAuto：自动分配权重的轮询调度。在 DescribeDBInstanceDetail 接口中做返回参数时，取值范围如下： Default：按规格权重自动分配。 Custom：自定义分配权重。 RoundRobin：轮询调度。 LoadSchedule：负载调度。 RoundRobinCustom：自定义权重的轮询调度。 RoundRobinAuto：自动分配权重的轮询调度。
ReadOnlyNodeMaxDelayTime	Integer	40	只读节点延迟阈值。取值范围为 1~3600，默认为 30，单位为秒。
ReadOnlyNodeWeight	Array of NodeWeightObject	请参见返回示例。	连接终端配置的节点列表及对应的只读权重。
ReadWriteMode	String	ReadOnly	读写模式： ReadWrite：读写。 ReadOnly：只读。

AddressObject

参数	类型	示例值	描述
DNSVisibility	Boolean	false	false：火山引擎私网解析（默认）。 true：火山引擎私网以及公网解析。
Domain	String	mysql1d797b6f****.rds.ivolces.com	连接域名。
EipId	String	eip-13g6t81tglmgw3n6nu4vt****	EIP 的 ID，仅对 Public 地址有效。
IPAddress	String	10...3	IP 地址。
InternetProtocol	String	IPv4	IP 协议版本。取值为 IPv4。
NetworkType	String	Private	网络地址类型，取值为： Private：私网地址。 Public：公网地址。
Port	String	3306	端口。
SubnetId	String	subnet-2bzr8zdx5o8ao2dx0efq4****	子网 ID，仅对 Private 地址有效。
EipLocked	Boolean	false	连接终端使用的 EIP 是否因欠费关停。取值： true：是。 false：否。

NodeWeightObject

参数	类型	示例值	描述
NodeId	String	mysql-050b3e08****-2	只读节点需要传入 NodeId，主节点无需传入。
NodeType	String	Primary	节点类型。 Primary：主节点。 ReadOnly：只读节点。
Weight	Integer	100	节点的读权重，以 100 递增，最大值为 10000。说明权重不可全部设置为 0。

NodeObject

参数	类型	示例值	描述
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。

ProxyInfoObject

参数	类型	示例值	描述
DBProxyStatus	String	Shutdown	实例的数据库代理功能状态。取值： Creating：代理开启中。 Running：代理运行中。 Shutdown：代理已关闭。 Deleting：代理关闭中。
ProxyResourceInfo	Object of ProxyResourceInfo	请参见返回示例。	实例的数据库代理服务的资源信息。

ProxyResourceInfo

参数	类型	示例值	描述
CurrentProxyCpuNum	Integer	2	实例数据库代理服务当前的核数。
MaxProxyCpuNum	Integer	1024	用户可为数据库代理服务配置的最多核数。
MinProxyCpuNum	Integer	2	用户可为数据库代理服务配置的最少核数。

DisasterRecoveryInstance

参数	类型	示例值	描述
DtsTaskId	String	9c0c17a0b82f460b87b338d1db8d****	主实例与灾备实例之间同步任务的 ID。
DtsTaskName	String	TestTask	主实例与灾备实例之间同步任务的名称。
DtsTaskStatus	String	Running	主实例与灾备实例之间同步任务的状态。
InstanceId	String	mysql-6c7c35fb****	灾备实例的 ID。
InstanceName	String	DrInstance-test	灾备实例的名称。
Region	String	cn-shanghai	灾备实例所处的地域。
SecondsBehindMaster	Integer	0	灾备实例与主实例之间的时延。

示例

请求示例

返回示例

错误码

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

云数据库 MySQL 版