1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
该接口用于查看指定执行资源组的监控指标
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetResourceGroupMetrics。 |
Version | 是 | String | 公共参数,本接口取值:2025-08-06。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ResourceGroupId | 是 | String | 执行资源组id 示例值:20240401132517098618 |
StartTime | 否 | Integer | 使用趋势开始时间(毫秒),默认最近一小时 示例值:1757391457258 |
EndTime | 否 | Integer | 使用趋势结束时间(毫秒),默认当前 示例值:1757395057258 |
MetricType | 否 | String | 指标维度 - all --- 全部 - task --- 任务指标 - system --- 系统指标 示例值:all |
Granularity | 否 | Integer | 指标采集粒度,单位分钟,默认 1分钟 示例值:5 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | ResourceGroupMetrics | 执行组指标信息 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取执行机指标
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetResourceGroupMetrics
<公共请求参数>
{
"ResourceGroupId": "20240401132517098618",
"StartTime": null,
"EndTime": null,
"MetricType": null,
"Granularity": null
}
输出示例
{
"Response": {
"Data": {
"CpuNum": null,
"DiskVolume": null,
"LifeCycle": 0,
"MaximumConcurrency": null,
"MemSize": 0,
"MetricSnapshots": [
{
"MetricName": "CpuCoreUsage",
"SnapshotValue": 0,
"TrendList": [
{
"Timestamp": 1757392500000,
"Value": 0
},
{
"Timestamp": 1757392800000,
"Value": 0
},
{
"Timestamp": 1757393100000,
"Value": 0
},
{
"Timestamp": 1757393400000,
"Value": 0
},
{
"Timestamp": 1757393700000,
"Value": 0
},
{
"Timestamp": 1757394000000,
"Value": 0
},
{
"Timestamp": 1757394300000,
"Value": 0
},
{
"Timestamp": 1757394600000,
"Value": 0
},
{
"Timestamp": 1757394900000,
"Value": 0
},
{
"Timestamp": 1757395200000,
"Value": 0
},
{
"Timestamp": 1757395500000,
"Value": 0
},
{
"Timestamp": 1757395800000,
"Value": 0
}
]
},
{
"MetricName": "MemoryLoad",
"SnapshotValue": 0,
"TrendList": []
},
{
"MetricName": "CpuLoad",
"SnapshotValue": 0,
"TrendList": []
},
{
"MetricName": "DiskUsage",
"SnapshotValue": 0,
"TrendList": [
{
"Timestamp": 1757392500000,
"Value": 0
},
{
"Timestamp": 1757392800000,
"Value": 0
},
{
"Timestamp": 1757393100000,
"Value": 0
},
{
"Timestamp": 1757393400000,
"Value": 0
},
{
"Timestamp": 1757393700000,
"Value": 0
},
{
"Timestamp": 1757394000000,
"Value": 0
},
{
"Timestamp": 1757394300000,
"Value": 0
},
{
"Timestamp": 1757394600000,
"Value": 0
},
{
"Timestamp": 1757394900000,
"Value": 0
},
{
"Timestamp": 1757395200000,
"Value": 0
},
{
"Timestamp": 1757395500000,
"Value": 0
},
{
"Timestamp": 1757395800000,
"Value": 0
}
]
},
{
"MetricName": "MemoryUsage",
"SnapshotValue": 0,
"TrendList": [
{
"Timestamp": 1757392500000,
"Value": 0
},
{
"Timestamp": 1757392800000,
"Value": 0
},
{
"Timestamp": 1757393100000,
"Value": 0
},
{
"Timestamp": 1757393400000,
"Value": 0
},
{
"Timestamp": 1757393700000,
"Value": 0
},
{
"Timestamp": 1757394000000,
"Value": 0
},
{
"Timestamp": 1757394300000,
"Value": 0
},
{
"Timestamp": 1757394600000,
"Value": 0
},
{
"Timestamp": 1757394900000,
"Value": 0
},
{
"Timestamp": 1757395200000,
"Value": 0
},
{
"Timestamp": 1757395500000,
"Value": 0
},
{
"Timestamp": 1757395800000,
"Value": 0
}
]
},
{
"MetricName": "DiskUsed",
"SnapshotValue": 0,
"TrendList": [
{
"Timestamp": 1757392500000,
"Value": 0
},
{
"Timestamp": 1757392800000,
"Value": 0
},
{
"Timestamp": 1757393100000,
"Value": 0
},
{
"Timestamp": 1757393400000,
"Value": 0
},
{
"Timestamp": 1757393700000,
"Value": 0
},
{
"Timestamp": 1757394000000,
"Value": 0
},
{
"Timestamp": 1757394300000,
"Value": 0
},
{
"Timestamp": 1757394600000,
"Value": 0
},
{
"Timestamp": 1757394900000,
"Value": 0
},
{
"Timestamp": 1757395200000,
"Value": 0
},
{
"Timestamp": 1757395500000,
"Value": 0
},
{
"Timestamp": 1757395800000,
"Value": 0
}
]
}
],
"Status": 1
},
"RequestId": "550b8107-ad28-4b6d-b1dc-7de4a0d4adb4"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |