帮你快速理解、总结文档立即下载
文档中心>数据库智能管家 DBbrain>API 文档>表空间分析相关接口>查询表级空间 Top 对象（融合接口）

查询表级空间 Top 对象（融合接口）

最近更新时间：2026-09-22 01:30:29
我的收藏

本页目录：

1. 接口描述

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

表级空间 Top 对象查询（融合接口，多产品统一入口），按 SortBy 指定的排序字段返回实例内空间占用 Top N 的表/集合。支持产品：mysql（云数据库 MySQL）、cynosdb（TDSQL-C MySQL 版）、mongodb（云数据库 MongoDB）、postgres（云数据库 PostgreSQL）、dcdb（TDSQL MySQL 版）、tdsql（TDSQL）、mariadb（云数据库 MariaDB）。返回值根据产品类型返回对应字段：MySQL 系列返回 MysqlObjects，PostgreSQL 返回 PostgresObjects（PG 的 relation/bloat 字段与 MySQL 语义不同），MongoDB 返回 MongodbObjects。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeTopSpaceTablesV2。
Version 是 String 公共参数，本接口取值：2021-05-27。
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 是 String

实例ID。


示例值：cdb-lvgh1oyv
Product 是 String

服务产品类型，支持值包括：mysql（云数据库 MySQL）、cynosdb（TDSQL-C MySQL 版）、mongodb（云数据库 MongoDB）、postgres（云数据库 PostgreSQL）、dcdb（TDSQL MySQL 版）、tdsql（TDSQL）、mariadb（云数据库 MariaDB）。


示例值：mysql
Date 否 String

查询日期，格式：yyyy-MM-dd。默认当天。


示例值：2026-08-25
SortBy 否 String

排序字段。MySQL/PG/TDSQL 系列支持：PhysicalFileSize/DataLength/IndexLength/TotalLength/DataFree/FragRatio/TableRows，默认 PhysicalFileSize。MongoDB 支持：Collection.CollectionSize/Collection.StorageSize/Collection.Size/Collection.AvgObjSize/Collection.Count/Collection.TotalIndexSize，默认 Collection.CollectionSize。


示例值：PhysicalFileSize
Limit 否 Integer

返回数量，默认20，最大100。


示例值：100

3. 输出参数

参数名称 类型 描述
MysqlObjects Array of MysqlSpaceObjectItem

MySQL/PG/TDSQL 系列产品表级空间对象列表。当产品为 mysql/cynosdb/tdsql/dcdb/mariadb/postgres 时返回。


注意：此字段可能返回 null，表示取不到有效值。
PostgresObjects Array of PostgresSpaceObjectItem

PostgreSQL 产品表级空间对象列表。当产品为 postgres 时返回。字段语义与 MySQL 不同：使用 RelationSize / TableSize / IndexSize / TotalRelationSize / TableBloat 等 PG 特有指标。


注意：此字段可能返回 null，表示取不到有效值。
MongodbObjects Array of MongoDBTableSpaceItem

MongoDB 产品表级（集合级）空间对象列表。当产品为 mongodb 时返回。


注意：此字段可能返回 null，表示取不到有效值。
Timestamp Integer

数据采集时间戳（秒）。


示例值：1786559643
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询表空间分析

查询表空间分析

输入示例

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

{
    "InstanceId": "cdb-lvgh1oyv",
    "Product": "mysql",
    "Date": "2026-08-25",
    "SortBy": "PhysicalFileSize",
    "Limit": 100
}

输出示例

{
    "Response": {
        "MysqlObjects": [
            {
                "DataFree": 4,
                "DataLength": 10.5,
                "Engine": "InnoDB",
                "FragRatio": 21.05,
                "IndexLength": 4.5,
                "PhysicalFileSize": 23,
                "TableName": "txn_order",
                "TableRows": 148161,
                "TableSchema": "txn_test",
                "TotalLength": 19
            }
        ],
        "Timestamp": 1786559643,
        "RequestId": "190b39d8-0329-4901-a211-d7b2d024b5d7"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

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 该时间范围内的审计日志已下载
中国站