1. 接口描述
接口请求域名: dbbrain.tencentcloudapi.com 。
根据实例ID获取指定时间段的性能趋势。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDBPerfTimeSeries。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-27。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 需要获取性能趋势的实例ID。 示例值:cdb-test123 |
StartTime | 是 | Timestamp ISO8601 | 开始时间。 示例值:2019-01-01T00:00:00+08:00 |
EndTime | 是 | Timestamp ISO8601 | 结束时间。 示例值:2019-01-01T01:00:00+08:00 |
Metric | 是 | String | 指标名称,多个指标之间用逗号分隔。 示例值:binlog_disk_available,data_disk_available |
Product | 是 | String | 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 TDSQL-C for MySQL,"redis" - 云数据库 Redis,"mongodb" - 云数据库 MongoDB 示例值:mysql |
ClusterId | 否 | String | 需要获取性能趋势的集群ID。 示例值:tdsqlshard-1eu5znlw |
Period | 否 | Integer | 性能数据统计粒度。 示例值:60 |
InstanceNodeId | 否 | String | 实列节点ID。 示例值:95397a1418f36495af7d09433f2f575f3d53d852 |
InstanceProxyId | 否 | String | 实列代理ID。 示例值:a267221bfa30c571cabbea555121bc1c2c97e518 |
ProxyId | 否 | String | 代理节点ID。 示例值:a267221bfa30c571cabbea555121bc1c2c97e518 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | MonitorMetricSeriesData | 实列性能数据。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取性能趋势
输入示例
POST / HTTP/1.1
Host: dbbrain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBPerfTimeSeries
<公共请求参数>
{
"InstanceId": "cmgo-8d8e5c87",
"StartTime": "2025-03-19T00:00:00+08:00",
"EndTime": "2025-03-19T01:00:00+08:00",
"Metric": "cpuusage",
"Product": "mongodb"
}
输出示例
{
"Response": {
"Data": {
"Series": [
{
"Metric": "cpuusage",
"Unit": "%",
"Values": [
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1
]
}
],
"Timestamp": [
1742375760,
1742375765,
1742375770,
1742375775,
1742375780,
1742375785,
1742375790,
1742375795,
1742375800,
1742375805,
1742375810,
1742375815,
1742375820,
1742375825,
1742375830,
1742375835,
1742375840,
1742375845,
1742375850,
1742375855,
1742375860,
1742375865,
1742375870,
1742375875,
1742375880,
1742375885,
1742375890,
1742375895,
1742375900,
1742375905,
1742375910,
1742375915,
1742375920,
1742375925,
1742375930,
1742375935,
1742375940,
1742375945,
1742375950,
1742375955,
1742375960,
1742375965,
1742375970,
1742375975,
1742375980,
1742375985,
1742375990
]
},
"RequestId": "5dfcbdb4-b7ec-4d62-a8df-db5f5742a670"
}
}
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鉴权错误。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |