文档首页/ AI科学计算服务/ API参考/ API/ 应用管理/ 作业管理/ 获取子任务中实例的资源监控数据
更新时间:2025-07-08 GMT+08:00
分享

获取子任务中实例的资源监控数据

功能介绍

获取子任务中实例的资源监控数据。

URI

GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/{job_id}/tasks/{task_name}/instances/{instance_name}/metric-data

表1 路径参数

参数

是否必选

参数类型

描述

eihealth_project_id

String

参数解释

平台空间ID,您可以在平台单击所需的空间名称,进入空间设置页面查看。

约束限制

不涉及

取值范围

仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。

默认取值

不涉及

job_id

String

参数解释

作业ID。

约束限制

不涉及

取值范围

仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。

默认取值

不涉及

project_id

String

参数解释

项目ID,您可以从获取项目ID中获取。

约束限制

不涉及

取值范围

仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。

默认取值

不涉及

task_name

String

参数解释

子任务名称。

约束限制

不涉及

取值范围

长度为[1-128]个字符。

默认取值

不涉及

instance_name

String

参数解释

子任务实例名称。

约束限制

不涉及

取值范围

长度为[1-128]个字符。

默认取值

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

task_index

String

参数解释

子任务的并发序号。

约束限制

不涉及

取值范围

长度为[1-128]个字符。

默认取值

0

from_time

Long

参数解释

查询监控数据起始时间,UNIX时间戳,单位毫秒。

约束限制

不涉及

取值范围

不涉及

默认取值

当前时间。

to_time

Long

参数解释

查询监控数据截止时间,UNIX时间戳,单位毫秒。

约束限制

不涉及

取值范围

不涉及

默认取值

当前时间。

method

String

参数解释

统计方法。

约束限制

不涉及

取值范围

枚举值,取值范围:

  • maximum:表示最大值。

  • minimum:表示最小值。

  • average:表示平均值。

默认取值

maximum

metric_name

String

参数解释

查询的监控指标名称。

约束限制

不涉及

取值范围

  • container_cpu_util:cpu使用量。

  • container_mem_util:内存使用量。

  • container_gpu_util:gpu使用量。

  • container_gpu_memory_usage:显存使用量。

默认取值

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。

Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。

约束限制

不涉及

取值范围

长度为[1-32768]个字符。

默认取值

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data_points

Array of DataPointDto objects

参数解释

监控数据列表。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表5 DataPointDto

参数

参数类型

描述

timestamp

Long

参数解释

时间戳。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

unit

String

参数解释

数据单位。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

value

Number

参数解释

统计结果。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

请求示例

查询子任务中实例的资源监控数据。

https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/{job_id}/tasks/{task_name}/instances/{instance_name}/metric-data

响应示例

状态码:200

OK

{
  "data_points" : [ {
    "timestamp" : 1467892800000,
    "unit" : "Percent",
    "value" : 33.2
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档