批量计算查询作业任务实例的资源监控信息

1. 接口描述

接口请求域名： batch.tencentcloudapi.com 。

查询作业任务实例的资源使用监控信息。当前只支持查询弹性节点任务并且Job未删除；暂不支持计算环境类任务；该接口只支持查询作业实例时间范围之内的资源使用情况。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeJobMonitorData。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
JobId	是	String	作业ID；JobId详见作业列表示例值：job-97zcl3wt
TaskName	是	String	作业的Task名称，详见作业详情。示例值：demo-1
TaskInstanceIndex	是	Integer	作业任务实例的序号，详见任务详情示例值：0
MetricName	是	String	支持查询的指标；当前支持查询的任务指标； - CpuUsage：cpu利用率，单位：% - MemUsage：内存利用率，单位：% - LanOuttraffic：内网出带宽，单位：Bytes/s - LanIntraffic：内网入带宽，单位：Bytes/s - MaxDiskUsage：所有磁盘中的使用率最高的磁盘使用率，单位：% - TargetDiskUsage：指定磁盘的使用率，单位：%；配合Dimensions参数使用示例值：CpuUsage
StartTime	否	Timestamp ISO8601	查询任务实例的起始时间；如果未传入查询起始时间或传入的时间小于任务实例的创建时间（任务实例创建时间详见任务详情），会自动将查询时间调整到任务实例的创建时间。传入时间格式只支持零时区格式。示例值：2025-06-11T21:12:50Z
EndTime	否	Timestamp ISO8601	查询任务实例的终止时间；如果未传入查询终止时间或传入的时间大于任务实例的终止时间（任务实例终止时间详见任务详情），并且任务实例已经结束，会自动将查询终止时间调整到任务实例的终止时间；如果任务实例未结束，会自动将查询终止时间调整到当前时间。传入时间格式只支持零时区格式。示例值：2025-06-11T22:12:50Z
Dimensions.N	否	Array of Dimension	查询指标的扩展参数；当前只支持TargetDiskUsage; - TargetDiskUsage -支持的查询维度diskname, 维度值为磁盘挂载名，例如vdb；如果不传此参数，默认查询vdb磁盘的使用率。样例：[{"Name":"diskname", "Value":"vdb"}]

3. 输出参数

参数名称	类型	描述
Period	Integer	监控数据粒度，单位:秒；时间粒度随着查询的时间范围变化，查询时间范围越小，时间粒度越小。示例值：10
DataPoints	DataPointView	监控采集的数据。时间戳和对应的值一一对应；如果查询的任务重试，采集时间段涉及多个实例的话，某些时间段内的值为null, 表示对应时间点没有实例存在，也不存在对应的监控数据；相邻监控时间段之间的空值数量最多为10。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询作业实例的资源使用监控信息

输入示例

POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeJobMonitorData
<公共请求参数>

{
    "JobId": "job-1jj9noyr",
    "TaskName": "demo-1",
    "TaskInstanceIndex": 0,
    "MetricName": "CpuUsage"
}

输出示例

{
    "Response": {
        "RequestId": "a66adf73-110f-49b4-a173-c68c952d4428",
        "Period": 60,
        "DataPoints": {
            "Timestamps": [
                1749696420,
                1749696430,
                1749696440
            ],
            "Values": [
                0.1,
                0.2,
                0.3
            ]
        }
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

查询作业任务实例的资源监控信息

本页目录：