1. 接口描述
此接口处于预下线状态 。
预计下线时间:2025-02-03 15:33:36
接口请求域名: iecp.tencentcloudapi.com 。
产品下线
查询边缘单元监控数据
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeMonitorMetrics。 |
Version | 是 | String | 公共参数,本接口取值:2021-09-14。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
EdgeUnitId | 是 | Integer | IECP边缘单元ID 示例值:100000 |
QueryType | 是 | String | 查询维度 示例值:node |
StartTime | 是 | Integer | 起始时间Unix秒时间戳 示例值:1631928390 |
EndTime | 是 | Integer | 终止时间Unix秒时间戳 示例值:1631931990 |
Interval | 是 | Integer | 步长(分钟) 示例值:39 |
NodeName | 否 | String | 节点名称,查询节点监控时必填 示例值:node-123 |
Namespace | 否 | String | 命名空间,不填则默认为default 示例值:default |
PodName | 否 | String | Pod名称,查询Pod监控时必填 示例值:pod-123 |
WorkloadName | 否 | String | Workload名称,查询Workload监控时必填 示例值:application-123 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Metrics | Array of MonitorMetricsColumn | 查询监控指标结果 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询边缘单元节点监控数据
输入示例
POST / HTTP/1.1
Host: iecp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMonitorMetrics
<公共请求参数>
{
"EdgeUnitId": 100000,
"QueryType": "node",
"NodeName": "cvm-1m8veowe",
"StartTime": 1635388144,
"EndTime": 1635391744,
"Interval": 5
}
输出示例
{
"Response": {
"RequestId": "5ebf13a2-f925-4ba7-adff-ddbc21d355e3",
"Metrics": [
{
"ColumnName": "node_disk_usage",
"ColumnData": [
"9.691727257938775",
"9.692490297224907",
"9.693220866754183",
"9.693935201405031",
"9.694665770934307",
"9.695315166071442",
"9.695988913526218",
"9.696662660980996",
"9.697368878192629",
"9.698083212843477",
"9.698838134690396",
"9.6995849390981",
"9.70024245167445"
],
"ColumnTime": [
1635388144,
1635388444,
1635388744,
1635389044,
1635389344,
1635389644,
1635389944,
1635390244,
1635390544,
1635390844,
1635391144,
1635391444,
1635391744
],
"ColumnBelong": "",
"MaxValue": 9.70024245167445,
"MinValue": 9.691727257938775,
"AvgValue": 9.696009519333455
},
{
"ColumnName": "node_disk_total_bytes",
"ColumnData": [
"52709240832",
"52709240832",
"52709240832",
"52709240832",
"52709240832",
"52709240832",
"52709240832",
"52709240832",
"52709240832",
"52709240832",
"52709240832",
"52709240832",
"52709240832"
],
"ColumnTime": [
1635388144,
1635388444,
1635388744,
1635389044,
1635389344,
1635389644,
1635389944,
1635390244,
1635390544,
1635390844,
1635391144,
1635391444,
1635391744
],
"ColumnBelong": "",
"MaxValue": 52709240832,
"MinValue": 52709240832,
"AvgValue": 52709240832
},
{
"ColumnName": "node_disk_write_bytes",
"ColumnData": [
"80008.53333333334",
"78643.2",
"58982.4",
"74001.06666666667",
"61166.933333333334",
"54613.333333333336",
"57890.13333333333",
"63624.53333333333",
"79735.46666666666",
"56797.86666666667",
"79189.33333333333",
"54340.26666666667",
"62259.2"
],
"ColumnTime": [
1635388144,
1635388444,
1635388744,
1635389044,
1635389344,
1635389644,
1635389944,
1635390244,
1635390544,
1635390844,
1635391144,
1635391444,
1635391744
],
"ColumnBelong": "",
"MaxValue": 80008.53333333334,
"MinValue": 54340.26666666667,
"AvgValue": 66250.17435897436
},
{
"ColumnName": "node_network_receive_bps",
"ColumnData": [
"64728.53333333333",
"73516.26666666666",
"69508.26666666666",
"74443.73333333334",
"64478.4",
"64844.8",
"67715.73333333334",
"72483.2",
"69330.13333333333",
"69224",
"69659.2",
"64447.46666666667",
"66977.6"
],
"ColumnTime": [
1635388144,
1635388444,
1635388744,
1635389044,
1635389344,
1635389644,
1635389944,
1635390244,
1635390544,
1635390844,
1635391144,
1635391444,
1635391744
],
"ColumnBelong": "",
"MaxValue": 74443.73333333334,
"MinValue": 64447.46666666667,
"AvgValue": 68565.94871794872
},
{
"ColumnName": "node_cpu_usage",
"ColumnData": [
"2.307017543843304",
"2.4210526315871284",
"2.3403508772076975",
"2.3350877192672037",
"2.410526315787842",
"2.343859649099933",
"2.3491228069995707",
"2.3438596491407893",
"2.4087719298621524",
"2.333333333341514",
"2.3543859649400645",
"2.3543859649400645",
"2.331578947374968"
],
"ColumnTime": [
1635388144,
1635388444,
1635388744,
1635389044,
1635389344,
1635389644,
1635389944,
1635390244,
1635390544,
1635390844,
1635391144,
1635391444,
1635391744
],
"ColumnBelong": "",
"MaxValue": 2.4210526315871284,
"MinValue": 2.307017543843304,
"AvgValue": 2.356410256414787
},
{
"ColumnName": "node_memory_usage",
"ColumnData": [
"16.271007823621233",
"16.233623556045686",
"16.257574479562052",
"16.244453538853087",
"16.25143054700785",
"16.251326412557777",
"16.25278429485878",
"16.26382254656632",
"16.272778109272444",
"16.262677067615538",
"16.310995452448562",
"16.270070613570596",
"16.273090512622655"
],
"ColumnTime": [
1635388144,
1635388444,
1635388744,
1635389044,
1635389344,
1635389644,
1635389944,
1635390244,
1635390544,
1635390844,
1635391144,
1635391444,
1635391744
],
"ColumnBelong": "",
"MaxValue": 16.310995452448562,
"MinValue": 16.233623556045686,
"AvgValue": 16.262741150354046
},
{
"ColumnName": "node_disk_read_bytes",
"ColumnData": [
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0"
],
"ColumnTime": [
1635388144,
1635388444,
1635388744,
1635389044,
1635389344,
1635389644,
1635389944,
1635390244,
1635390544,
1635390844,
1635391144,
1635391444,
1635391744
],
"ColumnBelong": "",
"MaxValue": 0,
"MinValue": 0,
"AvgValue": 0
},
{
"ColumnName": "node_network_transmit_bps",
"ColumnData": [
"143381.86666666667",
"149166.93333333332",
"144343.46666666667",
"147204.8",
"140089.06666666668",
"141895.46666666667",
"142944",
"145191.46666666667",
"143062.4",
"142919.46666666667",
"143495.46666666667",
"142087.46666666667",
"142670.93333333332"
],
"ColumnTime": [
1635388144,
1635388444,
1635388744,
1635389044,
1635389344,
1635389644,
1635389944,
1635390244,
1635390544,
1635390844,
1635391144,
1635391444,
1635391744
],
"ColumnBelong": "",
"MaxValue": 149166.93333333332,
"MinValue": 140089.06666666668,
"AvgValue": 143727.13846153847
},
{
"ColumnName": "node_pod_num",
"ColumnData": [
"8",
"8",
"8",
"8",
"8",
"8",
"8",
"8",
"8",
"8",
"8",
"8",
"8"
],
"ColumnTime": [
1635388144,
1635388444,
1635388744,
1635389044,
1635389344,
1635389644,
1635389944,
1635390244,
1635390544,
1635390844,
1635391144,
1635391444,
1635391744
],
"ColumnBelong": "",
"MaxValue": 8,
"MinValue": 8,
"AvgValue": 8
}
]
}
}
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 | 内部错误。 |
InternalError.DBError | 数据库异常。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.DuplicateName | 名字冲突。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnsupportedOperation | 操作不支持。 |