数据库智能管家 DBbrain 查询单表（单集合）空间明细（融合

1. 接口描述

接口请求域名： dbbrain.tencentcloudapi.com 。

表空间数据查询（融合接口，多产品统一入口）。按入参 TableSchema + TableName（PG 系额外需 TableCatalog）定位单张表/集合，返回该表的空间使用明细。支持产品：mysql（云数据库 MySQL）、cynosdb（TDSQL-C MySQL 版）、mongodb（云数据库 MongoDB）、postgres（云数据库 PostgreSQL）、sqlserver（SQL Server）、dcdb（TDSQL MySQL 版）、tdsql（TDSQL）、mariadb（云数据库 MariaDB）。返回值按产品隔离：MySQL 系列返回 MysqlTableSpaceData；PostgreSQL 返回 PostgresTableSpaceData；MongoDB 返回 MongodbTableSpaceData（含集合明细列表 SpaceSchemas 和外层 Timestamp）；SQL Server 返回 SqlServerTableSpaceData。注意：只读实例（CDB RO / RO 组 / CynosDB RO / TDSQL-C 集群 RO）不支持空间分析，调用将直接报错。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeTableSpaceDataV2。
Version	是	String	公共参数，本接口取值：2021-05-27。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例ID。示例值：postgres-40b08oij
Product	是	String	服务产品类型（用于云 API 平台路由到对应产品后端）。取值：mysql / cynosdb / mariadb / postgres / mongodb / sqlserver 等。示例值：postgres
TableSchema	是	String	数据库名（PG 系产品的 schema 名；MongoDB 为 database 名；MySQL / CynosDB / SqlServer 为库名）。PostgreSQL / MySQL / CynosDB / SqlServer 必传；MongoDB 可不传（底层使用 optString(""), 不传时按空库名查询）。示例值：public
TableName	是	String	表名（MongoDB 场景下为 collection 名，如 oplog.rs）。PostgreSQL / MySQL / CynosDB / SqlServer 必传；MongoDB 可不传（底层对该字段为空时直接返回空列表而非报错）。示例值：tencentdb_tbl_dial_test_long_1q9b045f8w1
TableCatalog	否	String	表所在的 Catalog（数据库目录）名。PostgreSQL / TBase 等 PG 系产品必传（例如 postgres），用于唯一定位 (catalog, schema, name) 三元组；MySQL / CynosDB / MongoDB / SqlServer 等非 PG 系产品可不传。示例值：postgres
Date	否	String	查询日期，格式：yyyy-MM-dd。MySQL / CynosDB / PostgreSQL / SqlServer 可选（默认当天）；MongoDB 本接口不读取该字段（底层通过 dbbrain.collInfo 直接查询实时集合空间，不区分日期）。示例值：2026-10-22
SortBy	否	String	排序字段。本接口（单表/单集合明细查询）均为可选：MySQL / CynosDB 可选，默认按 total_length 排序；PostgreSQL 可选，默认按 relation_size 排序；SqlServer 本接口不消费该字段的值；MongoDB 本接口完全不读取该字段。如需在 Top 表/库场景使用排序，请改用 DescribeTopSpaceTablesV2 / DescribeTopSpaceSchemasV2 接口。示例值：total_length
Limit	否	Integer	返回条数上限，默认 20，最大 100。MySQL / CynosDB / PostgreSQL 本接口会读取该参数控制明细条数；MongoDB 本接口不读取该字段（底层按入参 TableName 精确匹配返回集合明细，不受 Limit 控制）；SqlServer 本接口会校验但不消费其值。示例值：100
Regex	否	Boolean	MongoDB 专用——表名/集合名是否按正则模糊匹配。默认 true。其他产品忽略该字段。示例值：true

3. 输出参数

参数名称	类型	描述
MysqlTableSpaceData	MysqlSpaceObjectItem	MySQL 系列产品表空间数据。当产品为 mysql/cynosdb/tdsql/dcdb/mariadb 时返回。注意：此字段可能返回 null，表示取不到有效值。
PostgresTableSpaceData	PostgresSpaceObjectItem	PostgreSQL 产品表空间数据。当产品为 postgres 时返回。字段语义与 MySQL 不同：使用 RelationSize / TableSize / IndexSize / TotalRelationSize / TableBloat 等 PG 特有指标。注意：此字段可能返回 null，表示取不到有效值。
MongodbTableSpaceData	MongodbSpaceObjectItem	MongoDB 产品表空间数据。当产品为 mongodb 时返回。包含集合级明细数组 SpaceSchemas 以及外层采集时间戳 Timestamp（秒级）。注意：此字段可能返回 null，表示取不到有效值。
SqlServerTableSpaceData	SqlServerSpaceObjectItem	SQL Server 产品表空间数据。当产品为 sqlserver 时返回。字段结构与 MysqlSpaceObjectItem 同构，无 FragRatio / PhysicalFileSize。注意：此字段可能返回 null，表示取不到有效值。
Timestamp	Integer	数据采集时间戳（秒）。可能为空（部分产品分支/异常场景下不保证返回），调用方请做空值兼容。注意：此字段可能返回 null，表示取不到有效值。示例值：1792598400
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询postgres表空间数据

查询postgres表空间数据

输入示例

POST / HTTP/1.1
Host: dbbrain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTableSpaceDataV2
<公共请求参数>

{
    "InstanceId": "postgres-40b08oij",
    "Product": "postgres",
    "TableSchema": "public",
    "TableName": "tencentdb_tbl_dial_test_long_1q9b045f8w1",
    "TableCatalog": "postgres",
    "Date": "2026-10-22"
}

输出示例

{
    "Response": {
        "PostgresTableSpaceData": {
            "IndexSize": 0,
            "RelationSize": 0,
            "TableBloat": 1,
            "TableCatalog": "postgres",
            "TableName": "tencentdb_tbl_dial_test_long_1q9b045f8w1",
            "TableRows": 1,
            "TableSchema": "public",
            "TableSize": 0,
            "TableStatus": 0,
            "TotalRelationSize": 0
        },
        "Timestamp": 1792598400,
        "RequestId": "04d5a126-4883-4978-aabe-72eff28132cb"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure	CAM签名/鉴权错误。
DryRunOperation	DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。
FailedOperation	操作失败。
FailedOperation.AuditNotOpened	实例审计未开启
FailedOperation.PaasAuditNotOpened	paas 侧商业审计状态未开启
FailedOperation.SegmentLoading	数据加载中
InternalError	内部错误。
InternalError.DbOperationFailed	数据库操作失败
InternalError.InternalError	InternalError.InternalError
InvalidFilter	无效的过滤器
InvalidParameter	参数错误。
InvalidParameter.InvalidParameter	InvalidParameter.InvalidParameter
InvalidParameterCombination	无效参数组合
InvalidParameterValue	参数取值错误。
InvalidParameterValue.InvalidParameterValue	InvalidParameterValue.InvalidParameterValue
LimitExceeded	超过配额限制。
MissingParameter	缺少参数错误。
MissingParameter.MissingParameter	MissingParameter.MissingParameter
OperationDenied	操作被拒绝。
OperationDenied.UserHasNoStrategy	CAM鉴权错误。
RegionError	地域错误
RequestLimitExceeded	请求的次数超过了频率限制。
ResourceInUse	资源被占用。
ResourceInsufficient	资源不足。
ResourceNotFound	资源不存在。
ResourceUnavailable	资源不可用。
ResourcesSoldOut	资源售罄。
UnauthorizedOperation	未授权操作。
UnauthorizedOperation.UnauthorizedOperation	UnauthorizedOperation.UnauthorizedOperation
UnknownParameter	未知参数错误。
UnsupportedOperation	操作不支持。
UnsupportedOperation.HasDuplicatedTask	该时间范围内的审计日志已下载

查询单表（单集合）空间明细（融合接口）

本页目录：