1. 接口描述
接口请求域名: monitor.api3.fincloud.tencent.cn。
根据维度条件查询监控数据
默认接口请求频率限制:20次/秒。
接口更新时间:2021-04-21 15:13:52。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeStatisticData |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-07-24 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Module | 是 | 否 | String | 所属模块,固定值,为monitor 示例值: monitor |
| Namespace | 是 | 否 | String | 命名空间,目前只支持QCE/TKE 示例值: QCE/TKE2 |
| MetricNames | 是 | 否 | Array of String | 指标名列表 示例值: ["K8sPodCpuCoreUsed"] |
| Conditions | 否 | 否 | Array of MidQueryCondition | 维度条件,操作符支持=、in 示例值:查看 |
| Period | 否 | 否 | Uint64 | 统计粒度。默认取值为300,单位为s 示例值: 300 |
| StartTime | 否 | 否 | String | 起始时间,默认为当前时间,如2020-12-08T19:51:23+08:00 示例值: 2020-11-24T15:15:50+08:00 |
| EndTime | 否 | 否 | String | 结束时间,默认为当前时间,如2020-12-08T19:51:23+08:00 示例值: 2020-11-24T15:25:50+08:00 |
| GroupBys | 否 | 否 | Array of String | 按指定维度groupBy 示例值: ["K8sPodCpuCoreUsed"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Period | Uint64 | 统计周期 示例值: 300 |
| StartTime | String | 开始时间 示例值: 2020-11-24 15:15:00 |
| EndTime | String | 结束时间 示例值: 2020-11-24 15:25:00 |
| Data | Array of MetricData | 监控数据 示例值:查看 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.UnauthorizedOperation | 请求未授权。请参考 CAM 文档对鉴权的说明。 |
| InvalidParameterValue.InvalDashboardNameExists | dashboard 名重复。 |
| FailedOperation | 操作失败。 |
| FailedOperation.DbRecordUpdateFailed | 数据库记录更新失败。 |
| InvalidParameter.InvalidParameter | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| FailedOperation.DataQueryFailed | 数据查询失败。 |
| InvalidParameter.InvalidParameterParam | 参数错误。 |
| UnauthorizedOperation | 未授权操作。 |
| FailedOperation.DbTransactionCommitFailed | 数据库事务提交失败。 |
| InvalidParameter | 参数错误。 |
| FailedOperation.DataTableNotFound | 数据表不存在。 |
| FailedOperation.DbRecordDeleteFailed | 数据库记录删除失败。 |
| ResourceInsufficient | 资源不足。 |
| FailedOperation.DbQueryFailed | 数据库查询失败。 |
| FailedOperation.DimQueryRequestFailed | 请求维度查询服务失败。 |
| ResourceInUse | 资源被占用。 |
| ResourceNotFound | 资源不存在。 |
| FailedOperation.DbRecordCreateFailed | 创建数据库记录失败。 |
| InternalError | 内部错误。 |
| LimitExceeded | 超过配额限制。 |
| FailedOperation.DataColumnNotFound | 数据表字段不存在。 |
| FailedOperation.DbTransactionBeginFailed | 数据库事务开始失败。 |
| InvalidParameterValue | 无效的参数值。 |
| InvalidParameterValue.VersionMismatch | 版本不一致。 |
| UnknownParameter | 未知参数错误。 |
5. 示例
示例1 根据维度条件查询监控数据
输入示例
POST / HTTP/1.1
Host: monitor.api3.fincloud.tencent.cn
Content-Type: application/json
X-TC-Action: DescribeStatisticData
<公共请求参数>
{
"Module": "monitor",
"Namespace": "QCE/TKE",
"MetricNames": [
"K8sPodCpuCoreUsed"
],
"Period": 300,
"Conditions": [
{
"Key": "tke_cluster_instance_id",
"Operator": "=",
"Value": [
"cls-mw2w40s7"
]
}
],
"StartTime": "2020-11-24T15:15:50+08:00",
"EndTime": "2020-11-24T15:25:50+08:00"
}
https://monitor.api3.fincloud.tencent.cn/?Action=DescribeAllNamespaces&Module="monitor"&Namespace="1598976507"&MetricNames="1598976507"&Period="1000000"&Conditions="1598976507"&StartTime="1000000"&EndTime="1000000"
&<公共请求参数>
输出示例
{
"Response": {
"Data": [
{
"MetricName": "K8sPodCpuCoreUsed",
"Points": [
{
"Dimensions": [
{
"Name": "tke_cluster_instance_id",
"Value": "cls-mw2w40s7"
},
{
"Name": "node",
"Value": "cls-gn7vut9a-virtual-kubelet-subnet-node-2"
},
{
"Name": "pod_name",
"Value": "proxy-edge-j7j95"
},
{
"Name": "workload_name",
"Value": "init-test-nfs02"
},
{
"Name": "namespace",
"Value": "default-test"
},
{
"Name": "node_role",
"Value": "node"
},
{
"Name": "un_instance_id",
"Value": "cls-gn7vut9a-virtual-kubelet-subnet-nmpi5ecw-1"
},
{
"Name": "workload_kind",
"Value": "Deployment"
}
],
"Values": [
{
"Timestamp": 1606202100,
"Value": 41.066
},
{
"Timestamp": 1606202400,
"Value": 38.666
},
{
"Timestamp": 1606202700,
"Value": 37.866
}
]
},
{
"Dimensions": [
{
"Name": "namespace",
"Value": "default-test"
},
{
"Name": "node",
"Value": "cls-gn7vut9a-virtual-kubelet-subnet-node-3"
},
{
"Name": "node_role",
"Value": "node"
},
{
"Name": "pod_name",
"Value": "network-tools-b94d6dd89-flf7n"
},
{
"Name": "un_instance_id",
"Value": "cls-gn7vut9a-virtual-kubelet-subnet-nmpi5ecw-1"
},
{
"Name": "workload_kind",
"Value": "Deployment"
},
{
"Name": "workload_name",
"Value": "init-test-nfs00"
},
{
"Name": "tke_cluster_instance_id",
"Value": "cls-mw2w40s7"
}
],
"Values": [
{
"Timestamp": 1606202100,
"Value": 42.666
},
{
"Timestamp": 1606202400,
"Value": 33.6
},
{
"Timestamp": 1606202700,
"Value": 40.266
}
]
}
]
}
],
"EndTime": "2020-11-24 15:25:00",
"Period": 300,
"RequestId": "0d25d659-71ee-4c93-b8e1-f3992c61ff46",
"StartTime": "2020-11-24 15:15:00"
}
}