1. 接口描述
接口请求域名: mariadb.tencentcloudapi.com 。
本接口(DescribeDBResourceUsage)用于查看数据库实例资源的使用情况。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDBResourceUsage。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例 ID,形如:tdsql-ow728lmc。 |
StartTime | 是 | Date | 开始日期,格式yyyy-mm-dd |
EndTime | 是 | Date | 结束日期,格式yyyy-mm-dd |
MetricName | 否 | String | 拉取的指标名称,支持的值为:data_disk_available,binlog_disk_available,mem_available,cpu_usage_rate |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
BinlogDiskAvailable | MonitorData | binlog日志磁盘可用空间,单位GB |
DataDiskAvailable | MonitorData | 磁盘可用空间,单位GB |
CpuUsageRate | MonitorData | CPU利用率 |
MemAvailable | MonitorData | 内存可用空间,单位GB |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查看实例资源使用情况
输入示例
https://mariadb.tencentcloudapi.com/?Action=DescribeDBResourceUsage
&InstanceId=tdsql-ige1a5k3
&StartTime=2018-03-19
&EndTime=2018-03-19
&<公共请求参数>
输出示例
{
"Response": {
"MemAvailable": {
"EndTime": "2018-03-24 23:59:59",
"Data": [
1,
1,
1
],
"StartTime": "2018-03-24 00:00:00"
},
"CpuUsageRate": {
"EndTime": "2018-03-24 23:59:59",
"Data": [
1,
1,
1
],
"StartTime": "2018-03-24 00:00:00"
},
"RequestId": "32a93b23-cbd8-48a9-a75a-2274625099ca",
"BinlogDiskAvailable": {
"EndTime": "2018-03-24 23:59:59",
"Data": [
1,
1,
1
],
"StartTime": "2018-03-24 00:00:00"
},
"DataDiskAvailable": {
"EndTime": "2018-03-24 23:59:59",
"Data": [
1,
1,
1
],
"StartTime": "2018-03-24 00:00:00"
}
}
}
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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.OssOperationFailed | 请求后端接口失败。 |
InternalError.CamAuthFailed | CAM鉴权请求失败。 |
InternalError.FetchMetricDataFailed | 获取监控数据失败。 |
InternalError.GetInstanceDetailFailed | 获取实例详情失败。 |
InternalError.InnerSystemError | 内部系统错误。 |
InvalidParameter.GenericParameterError | 参数合法性校验错误。 |
InvalidParameter.InstanceNotFound | 未找到请求的实例。 |
InvalidParameterValue.ShardNotExist | 分片不存在。 |
ResourceNotFound.NoInstanceFound | 找不到指定的数据库实例。 |
ResourceUnavailable.InstanceStatusAbnormal | 数据库实例状态不正确,当前无法操作。 |
UnauthorizedOperation.PermissionDenied | 没有权限操作该接口或资源。 |