1. 接口描述
接口请求域名： dcdb.api3.fincloud.tencent.com。
本接口（DescribeDCDBInstanceDetail）用于获取实例详情
默认接口请求频率限制：20次/秒。
接口更新时间：2025-05-10 15:50:10。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeDCDBInstanceDetail |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-04-11 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 是 | 否 | String | 实例ID，形如dcdbt-7oaxtcb7 示例值： tdsqlshard-rlye31jd |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID，形如dcdbt-7oaxtcb7 示例值： tdsqlshard-rlye31jd |
| InstanceName | String | 实例名称 示例值： tdsqlshard-rlye31jd |
| Status | Int64 | 实例状态。0-实例创建中；1-异步任务处理中；2-运行中；3-实例未初始化；-1-实例已隔离 示例值： 2 |
| StatusDesc | String | 实例目前运行状态描述 示例值： 运行中 |
| Vip | String | 实例内网IP地址 示例值： 172.16.0.39 |
| Vport | Int64 | 实例内网端口 示例值： 3306 |
| NodeCount | Int64 | 实例节点数。值为2时表示一主一从，值为3时表示一主二从 示例值： 2 |
| Region | String | 实例所在地域名称，形如ap-region1 示例值： ap-region1 |
| VpcId | String | 实例私有网络ID，形如vpc-r9jr0de3 示例值： vpc-4x1eyoyv |
| SubnetId | String | 实例私有网络子网ID，形如subnet-6rqs61o2 示例值： subnet-58oypmoq |
| WanStatus | Int64 | 外网状态，0-未开通；1-已开通；2-关闭；3-开通中；4-关闭中 示例值： 0 |
| WanDomain | String | 外网访问的域名，公网可解析 示例值： ceshi.cn |
| WanVip | String | 外网IP地址，公网可访问 示例值： 192.168.1.1 |
| WanPort | Int64 | 外网访问端口 示例值： 8888 |
| ProjectId | Int64 | 实例所属项目ID 示例值： 0 |
| AutoRenewFlag | Int64 | 实例自动续费标志。0-正常续费；1-自动续费；2-到期不续费 示例值： 0 |
| ExclusterId | String | 独享集群ID 示例值： Resource_pool1 |
| PayMode | String | 付费模式。prepaid-预付费；postpaid-按量计费 示例值： postpaid |
| CreateTime | Datetime | 实例创建时间，格式为 2006-01-02 15:04:05 示例值： 2020-04-08 13:59:39 |
| PeriodEndTime | Datetime | 实例到期时间，格式为 2006-01-02 15:04:05 示例值： 2020-05-08 13:59:39 |
| DbVersion | String | 数据库版本信息 示例值： 5.7.17 |
| IsAuditSupported | Int64 | 实例是否支持审计。0-不支持；1-支持 示例值： 1 |
| IsEncryptSupported | Int64 | 实例是否支持数据加密。0-不支持；1-支持 示例值： 0 |
| Machine | String | 实例母机机器型号 示例值： SH02D |
| Memory | Int64 | 实例内存大小，单位 GB，各个分片的内存大小的和 示例值： 12 |
| Storage | Int64 | 实例磁盘存储大小，单位 GB，各个分片的磁盘大小的和 示例值： 40 |
| StorageUsage | Float | 实例存储空间使用率，计算方式为：各个分片已经使用的磁盘大小的和/各个分片的磁盘大小的和。 示例值： 0.001 |
| LogStorage | Int64 | 日志存储空间大小，单位GB 示例值： 16 |
| Pid | Int64 | 产品类型ID 示例值： 11128 |
| MasterZone | String | 主DB可用区 示例值： ap-region1-1 |
| SlaveZones | Array of String | 从DB可用区 示例值： ["ap-region1-1"] |
| Shards | Array of ShardBriefInfo | 分片信息 示例值：查看 |
| Vip6 | String | 内网IPv6 示例值： FC00:0000:130F:0000:0000:09C0:876A:130B |
| Cpu | Int64 | 实例Cpu核数 示例值： 1 |
| Qps | Int64 | 实例QPS 示例值： 4000 |
| DbEngine | String | DB引擎 示例值： Mysql |
| Ipv6Flag | Int64 | 是否支持IPv6，1-支持，0-不支持 示例值： 0 |
| WanVipv6 | String | 外网IPv6地址，公网可访问 示例值： FC00:0000:130F:0000:0000:09C0:876A:130B |
| WanStatusIpv6 | Int64 | 外网状态，0-未开通；1-已开通；2-关闭；3-开通中；4-关闭中 示例值： 1 |
| WanPortIpv6 | Int64 | 外网IPv6端口 示例值： 8888 |
| ResourceTags | Array of ResourceTag | 标签信息 示例值：查看 |
| DcnFlag | Int64 | DCN标志，0-无，1-主实例，2-灾备实例 示例值： 0 |
| DcnStatus | Int64 | DCN状态，0-无，1-创建中，2-同步中，3-已断开 示例值： 0 |
| DcnDstNum | Int64 | DCN灾备实例数 示例值： 0 |
| PlatformProjectId | String | 平台项目ID 示例值： pr-49ed23d8 |
| PlatformProjectName | String | 平台项目名称 示例值： qta-tdsql-1 |
| InstanceType | Int64 | 1： 主实例（独享型）, 2: 主实例, 3： 灾备实例, 4： 灾备实例（独享型） 示例值： 2 |
| CpuArch | String | cpu架构 示例值： x86 |
| RsAccessStrategy | Int64 | 就近访问策略，0-无策略, 1-可用区就近访问 示例值： 0 |
| ExclusterName | String | 资源池名称 示例值： Resource_pool1 |
| ReservedNetResources | Array of ReservedNetResource | 尚未回收的网络资源 示例值：查看 |
| IsDcnSqlSyncSupported | Int64 | 是否支持强同步dcn，1-支持，0-不支持 示例值： 1 |
| TemplateDefault | String | 参数模板列表匹配用的模板版本号 示例值： 8.0.24 |
| IsMaxUserConnectionsSupported | Bool | 实例是否支持设置用户连接数限制，true-支持，false-不支持 示例值： true |
| IsDcnStrongSyncSupported | Int64 | 是否支持强同步dcn。1支持，0不支持 示例值： 1 |
| ExclusterType | Int64 | 独享集群类型，0:公有云或内部, 1:金融围笼, 2:CDC集群 示例值： 0 |
| IsDcnSwitchSupported | Int64 | 是否支持dcn切换，1-支持，0-不支持 示例值： 1 |
| OssId | String | OSS集群ID 示例值： 1 |
| GiftLogStoragePercentage | String | 日志存储空间大小与实例容量的百分比 示例值： 25% |
| DbVersionId | String | 对外数据库版本信息 示例值： 5.7 |
| IsPhysicalReplicationSupported | Bool | 是否支持物理复制，1-支持，0-不支持 示例值： 1 |
| EncryptStatus | Int64 | 加密状态, 0-未开启，1-已开启 示例值： 0 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.OssOperationFailed | 请求后端接口失败。 |
| InternalError.GetSubnetFailed | 查询虚拟私有网络子网信息失败。 |
| InternalError.OperateDatabaseFailed | 数据库操作失败。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InstanceNotFound | 未找到请求的实例。 |
| UnauthorizedOperation.PermissionDenied | 没有权限操作该接口或资源。 |