1. 接口描述
接口请求域名： dbbrain.api3.fincloud.tencent.com。
获取实例Top库的实时空间统计信息，默认返回按大小排序。
默认接口请求频率限制：20次/秒。
接口更新时间：2025-05-16 10:27:04。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeTopSpaceSchemas |
| Version | 是 | 否 | String | 公共参数，本接口取值：2021-05-27 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Limit | 否 | 是 | Int64 | 返回的Top库数量，最大值为100，默认为20。 示例值： 100 |
| SortBy | 否 | 是 | String | 筛选Top库所用的排序字段，可选字段包含DataLength、IndexLength、TotalLength、DataFree、FragRatio、TableRows、PhysicalFileSize（仅云数据库 MySQL实例支持），云数据库 MySQL实例默认为 PhysicalFileSize，其他产品实例默认为TotalLength。 示例值： TableRows |
| Product | 是 | 否 | String | 服务产品类型，支持值包括： "mariadb" - 数据库 MariaDB， "dcdb" - 数据库 TDSQL MySQL，默认为"mariadb"。 示例值： mariadb |
| InstanceId | 是 | 否 | String | 实例 ID 。 示例值： shard-lm6o3jwi |
| ClusterId | 否 | 是 | String | 集群 ID。 示例值： tdsqlshard-70m8bedq |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TopSpaceSchemas | Array of SchemaSpaceData | 返回的Top库空间统计信息列表。 示例值：查看 |
| Timestamp | Int64 | 采集库空间数据的时间戳（秒）。 示例值： 1603819881 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | |
| InvalidParameter | |
| UnauthorizedOperation | |
| UnsupportedOperation | |
| MissingParameter | |
| AuthFailure | |
| InternalError | |
| LimitExceeded | |
| ResourceNotFound | |
| OperationDenied | |
| FailedOperation | |
| UnknownParameter | |
| OperationDenied.UserHasNoStrategy |