# 查询训练作业指定任务的日志 - ShowTrainingJobLogsFromAom #### 功能介绍 查询训练作业指定任务的日志接口用于获取ModelArts平台上指定训练作业任务的实时运行日志。 该接口适用于以下场景：当用户需要查看特定训练任务的运行日志以便排查问题或监控训练进度时，可以通过此接口获取日志内容。使用该接口的前提条件是用户已知训练作业ID和任务ID，并具有查看日志的权限。查询操作完成后，平台将返回包含日志内容、起止行号等信息。若训练作业ID或任务ID不存在、任务未生成日志或用户无权限操作，接口将返回相应的错误信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=ShowTrainingJobLogsFromAom)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | modelarts:trainJob:getLogs | Read | trainJob \* | g:ResourceTag/\ | modelarts:trainJob:get | - | | modelarts:trainJob:getLogs | Read | - | g:EnterpriseProjectId | modelarts:trainJob:get | - | #### URI GET /v2/{project_id}/training-jobs/{training_job_id}/logs/{task_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：用户项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **约束限制**：不涉及。 **取值范围**：1 - 64字符，字母、数字和中划线。 **默认取值**：不涉及。 | | training_job_id | 是 | String | **参数解释** ：训练作业ID。获取方法请参见[查询训练作业列表](https://support.huaweicloud.com/api-modelarts/ListTrainingJobs.html#ZH-CN_TOPIC_0000002723741806)。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | task_id | 是 | String | **参数解释**：训练作业的任务ID。可从训练作业详情中的status.tasks字段中获取。 **约束限制**：不涉及。 **取值范围**：单节点默认为"worker-0"，多节点则为"worker-0"、"worker-1"，依次类推。 **默认取值**：不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | base_line | 否 | String | **参数解释**：日志查询的基线行号，用于分页查询。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及（从最新日志开始查询）。 | | lines | 否 | Integer | **参数解释**：返回的日志行数。 **约束限制**：不涉及。 **取值范围**：1 \~ 500。 **默认取值**：50。 | | order | 否 | String | **参数解释**：日志排序方式。 **约束限制**：不涉及。 **取值范围**：枚举值如下： - asc：升序（从旧到新） - desc：降序（从新到旧） **默认取值**：desc。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | start_line | String | **参数解释**：返回日志的起始行号。 **取值范围**：不涉及。 | | end_line | String | **参数解释**：返回日志的结束行号。 **取值范围**：不涉及。 | | lines | Integer | **参数解释**：返回的日志行数。 **取值范围**：不涉及。 | | content | String | **参数解释**：日志内容。 **取值范围**：不涉及。 | #### 请求示例 如下以查询uuid为2cd88daa-31a4-40a8-a58f-d186b0e93e4f的训练作业对应worker-0的日志为例。 ``` GET https://{endpoint}/v2/{project_id}/training-jobs/2cd88daa-31a4-40a8-a58f-d186b0e93e4f/logs/worker-0 ``` #### 响应示例 **状态码：200** ``` { "start_line" : "123", "end_line" : "173", "lines" : 50, "content" : "[ModelArts Service Log][INFO][2021/05/18 14:28:14,207]:\n output-handler finalizing due to: [training finished]\n[ModelArts Service Log][INFO][2021/05/18 14:28:14,207]:\n output-handler finalized" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询训练作业日志响应体 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。