1. 接口描述
接口请求域名： dbbrain.tencentcloudapi.com 。
获取实例占用空间最大的前几个库在指定时间段内的每日由DBbrain定时采集的空间数据，默认返回按大小排序。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTopSpaceSchemaTimeSeries。 |
| Version | 是 | String | 公共参数，本接口取值：2021-05-27。 |
| 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 |
| StartDate | 否 | Date | 开始日期，如“2021-01-01”，最早为当日的前第29天，默认为截止日期的前第6天。 示例值：2021-01-01 |
| EndDate | 否 | Date | 截止日期，如“2021-01-01”，最早为当日的前第29天，默认为当日。 示例值：2021-01-01 |
| Product | 否 | String | 服务产品类型，支持值包括： "mysql" - 云数据库 MySQL， "cynosdb" - 云数据库 CynosDB for MySQL，默认为"mysql"。 示例值：mysql |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TopSpaceSchemaTimeSeries | Array of SchemaSpaceTimeSeries | 返回的Top库空间统计信息的时序数据列表。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取Top库在指定时间段内的每日空间统计信息
输入示例
https://dbbrain.tencentcloudapi.com/?Action=DescribeTopSpaceSchemaTimeSeries
&InstanceId=cdb-test
&Limit=2
&StartDate=2021-01-01
&EndDate=2021-01-01
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "d97eacb0-cebd-40b6-963b-579092454f05",
"TopSpaceSchemaTimeSeries": [
{
"TableSchema": "test_bak",
"SeriesData": {
"Series": [
{
"Values": [
0
],
"Metric": "DataFree",
"Unit": "MB"
},
{
"Values": [
0.1
],
"Metric": "DataLength",
"Unit": "MB"
},
{
"Values": [
0
],
"Metric": "IndexLength",
"Unit": "MB"
},
{
"Values": [
0.1
],
"Metric": "TotalLength",
"Unit": "MB"
},
{
"Values": [
0
],
"Metric": "FragRatio",
"Unit": "%"
},
{
"Values": [
9
],
"Metric": "TableRows",
"Unit": ""
},
{
"Values": [
0.1
],
"Metric": "PhysicalFileSize",
"Unit": "MB"
}
],
"Timestamp": [
1588089600
]
}
},
{
"TableSchema": "test_bak",
"SeriesData": {
"Series": [
{
"Values": [
0
],
"Metric": "DataFree",
"Unit": "MB"
},
{
"Values": [
0.1
],
"Metric": "DataLength",
"Unit": "MB"
},
{
"Values": [
0
],
"Metric": "IndexLength",
"Unit": "MB"
},
{
"Values": [
0.1
],
"Metric": "TotalLength",
"Unit": "MB"
},
{
"Values": [
0
],
"Metric": "FragRatio",
"Unit": "%"
},
{
"Values": [
6
],
"Metric": "TableRows",
"Unit": ""
},
{
"Values": [
0.1
],
"Metric": "PhysicalFileSize",
"Unit": "MB"
}
],
"Timestamp": [
1588089600
]
}
}
]
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.UserHasNoStrategy | CAM鉴权错误。 |
| ResourceNotFound | 资源不存在。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
