查询训练性能分析任务列表 - ListTrainingJobProfilingTasks

功能介绍

查询训练性能分析任务接口，用于在ModelArts平台上查询指定训练作业的性能分析任务信息。

该接口适用于以下场景：当用户需要查看特定训练作业的性能分析任务的运行状态时，可以通过此接口获取性能分析任务详情。使用该接口的前提条件是用户已知训练作业ID，并已创建过对应的性能分析任务。若作业ID不存在、状态不允许或用户无权限操作，接口将返回相应的错误信息

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
modelarts:trainJob:list
List
-
-
-
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
modelarts:trainJob:list	List	-	-	-	-

URI

GET /v2/{project_id}/training-jobs/{job_id}/profiling/tasks

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：用户项目ID。获取方法请参见获取项目ID和名称。约束限制：1 - 64字符，字母、数字和中划线。取值范围：不涉及。默认取值：不涉及。
job_id	是	String	参数解释：作业ID。约束限制：不涉及。取值范围：长度为32的英文字符、数字的组合。默认取值：不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数
参数	参数类型	描述
total	Integer	参数解释：性能分析作业总数。
count	Integer	参数解释：查询到当前用户名下的所有符合查询条件的作业总数。取值范围：不涉及。
limit	Integer	参数解释：查询作业的每页条目数。最小为1，最大为50。取值范围：不涉及。
offset	Integer	参数解释：查询作业的页数，最小为0。例如设置为0，则表示从第一页开始查询。取值范围：不涉及。
sort_by	String	参数解释：查询作业排列顺序的指标。默认使用create_time排序。取值范围：不涉及。
order	String	参数解释：查询作业排列顺序，默认为“desc”，降序排序。也可以选择对应的“asc”，升序排序。取值范围：不涉及。
group_by	String	参数解释：查询作业要搜索的分组条件。取值范围：不涉及。
items	Array of TrainingJobProfilingTask objects	参数解释：各个类型的性能分析作业详情。

表3 TrainingJobProfilingTask
参数	参数类型	描述
task_id	String	参数解释：性能分析作业ID。
job_id	String	参数解释：性能分析作业源训练作业ID。
created_at	String	参数解释：性能分析作业创建时间。
updated_at	String	参数解释：性能分析作业更新时间。
status	String	参数解释：性能分析任务状态。取值范围： Creating：创建中 Queueing：排队中 Running：运行中 Failed：任务失败 Completed: 任务完成
trigger_type	String	参数解释：性能分析作业的类型。取值范围：取值为Auto或Manual。默认取值：不涉及。
command_params	ProfilingCommandParams object	参数解释：性能分析作业的命令参数配置。
detect_rules	ProfilingDetectRules object	参数解释：性能分析作业的检测规则配置。

表4 ProfilingCommandParams
参数	参数类型	描述
iterations	Integer	参数解释：性能分析作业的采集迭代数配置。取值范围：最小为1，最大为3 默认取值：不涉及。
profiler_level	String	参数解释：性能分析作业的采集等级配置。取值范围：取值为Level0、Level1或Level2。默认取值：不涉及。
is_profile_memory	Boolean	参数解释：性能分析作业的采集算子内存配置。取值范围： true：支持 false：不支持
with_stack	Boolean	参数解释：性能分析作业的采集Python调用栈配置。取值范围： true：支持 false：不支持
msprof_tx	Boolean	参数解释：性能分析作业的采集通信算子、dataloader耗时配置。取值范围： true：支持 false：不支持
aic_metrics	String	参数解释：性能分析作业的AI Core性能指标配置。取值范围：取值为AiCoreNone、PipeUtilization、ArithmeticUtilization、Memory、MemoryL0、ResourceConflictRatio、MemoryUB、L2Cache或MemoryAccess。默认取值：不涉及。

表5 ProfilingDetectRules
参数	参数类型	描述
base_threshold	base_threshold object	参数解释：性能分析作业基于阈值的检测规则配置。

表6 base_threshold
参数	参数类型	描述
fluctuation_degree	Integer	参数解释：性能分析作业的采集迭代数配置。取值范围：最小为1。默认取值：5。

请求示例

GET https://endpoint/v2/{project_id}/training-jobs/{job_id}/profiling/tasks

响应示例

状态码：200

{
  "total" : 1,
  "count" : 1,
  "limit" : 50,
  "offset" : 0,
  "sort_by" : "create_time",
  "order" : "desc",
  "group_by" : "",
  "items" : [ {
    "task_id" : "ca96777f-892f-4d8b-af96-c30abe73f884",
    "job_id" : "e9e83c75-3f37-4bd1-a8a5-e693289f6dce",
    "created_at" : "2025-12-28T20:52:45.4472001+08:00",
    "updated_at" : "2025-12-28T20:52:45.4472001+08:00",
    "status" : "Creating",
    "trigger_type" : "Auto",
    "command_params" : {
      "iterations" : 1,
      "profiler_level" : "Level2"
    },
    "detect_rules" : {
      "base_threshold" : {
        "fluctuation_degree" : 5
      }
    }
  } ]
}