数据库智能管家 DBbrain
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 数据库智能管家 DBbrain > API 文档 > 数据库智能管家 DBbrain API 2019-10-16 > 其他接口 > 获取Top库的空间统计信息

获取Top库的空间统计信息

最近更新时间：2024-03-12 19:50:56

我的收藏

本页目录：

1. 接口描述

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

获取实例Top库的实时空间统计信息，默认返回按大小排序。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeTopSpaceSchemas。
Version 是 String 公共参数，本接口取值：2019-10-16。
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 是 String 实例 ID 。
示例值：cdb-c1nl9rpv
Limit 否 Integer 返回的Top库数量，最大值为100，默认为20。
示例值：100
SortBy 否 String 筛选Top库所用的排序字段，可选字段包含DataLength、IndexLength、TotalLength、DataFree、FragRatio、TableRows、PhysicalFileSize（仅云数据库 MySQL实例支持），云数据库 MySQL实例默认为 PhysicalFileSize，其他产品实例默认为TotalLength。
示例值：TableRows
Product 否 String 服务产品类型，支持值包括： "mysql" - 云数据库 MySQL， "cynosdb" - 云数据库 CynosDB for MySQL，默认为"mysql"。
示例值：mysql

3. 输出参数

参数名称 类型 描述
TopSpaceSchemas Array of SchemaSpaceData 返回的Top库空间统计信息列表。
Timestamp Integer 采集库空间数据的时间戳（秒）。
示例值：1603819881
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取Top库的空间统计信息

获取Top库的空间统计信息。

输入示例

https://dbbrain.tencentcloudapi.com/?Action=DescribeTopSpaceSchemas
&InstanceId=cdb-test
&Limit=2
&SortBy=TableRows
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "ed279d8b-a9d9-48d6-9429-e0fde000994a",
        "Timestamp": 1603819881,
        "TopSpaceSchemas": [
            {
                "DataFree": 0,
                "TotalLength": 0.1,
                "TableSchema": "test_bak",
                "FragRatio": 0,
                "DataLength": 0.1,
                "PhysicalFileSize": 0.1,
                "TableRows": 9,
                "IndexLength": 0
            },
            {
                "DataFree": 0,
                "TotalLength": 0.1,
                "TableSchema": "test_bak",
                "FragRatio": 0,
                "DataLength": 0.1,
                "PhysicalFileSize": 0.1,
                "TableRows": 9,
                "IndexLength": 0
            }
        ]
    }
}

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签名/鉴权错误。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.UserHasNoStrategy CAM鉴权错误。
中国站