查询训练作业的路由规划信息 - GetTrainingJobRoutePlan

功能介绍

查询训练作业的路由规划信息接口用于获取指定训练作业在Ascend规格专属资源池下的路由规划（rank映射）结果。

该接口适用于以下场景：当用户在Ascend 910规格专属资源池上创建了多节点（节点数不少于3）训练作业，且需要查询作业实际生效的rank映射关系以进行性能调优或问题定位时，可以通过此接口获取路由规划信息。使用该接口的前提条件是用户已知训练作业ID，并具有查看作业详情的权限。查询操作完成后，平台将返回该作业的路由规划状态与rank映射结果。若训练作业不满足路由规划条件（非Ascend 910规格或节点数少于3），接口将返回状态为failed的默认rank映射结果；若训练作业ID不存在或用户无权限操作，接口将返回相应的错误信息。

调试

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

授权信息

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

• 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
• 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v2/{project_id}/training-jobs/{training_job_id}/route_plan

请求参数

无

响应参数

状态码：200

请求示例

如下以查询training_job_id为3faf5c03-aaa1-4cbe-879d-24b05d997347的训练作业的路由规划信息为例。

GET https://{endpoint}/v2/{project_id}/training-jobs/3faf5c03-aaa1-4cbe-879d-24b05d997347/route_plan

响应示例

状态码：200

ok

{
  "job_id" : "3faf5c03-aaa1-4cbe-879d-24b05d997347",
  "status" : "success",
  "rank_mapping" : "0-0,1-0,2-1,3-1,4-2,5-2,6-3,7-3"
}

状态码

错误码

请参见错误码。