# 查询训练作业指定任务的日志（OBS链接） - ShowObsUrlOfTrainingJobLogs #### 功能介绍 查询训练作业指定任务的日志（OBS链接）接口用于获取指定训练作业任务的日志文件在OBS（对象存储服务）中的访问链接。 该接口适用于以下场景：当用户需要查看或下载训练作业任务的详细日志信息时，可以通过此接口获取日志文件的OBS链接。使用该接口的前提条件是训练作业任务已存在且用户具有相应的权限。查询操作完成后，接口将返回指定任务的日志文件的OBS链接。若训练作业任务不存在或用户无权限操作，接口将返回相应的错误信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=ShowObsUrlOfTrainingJobLogs)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | modelarts:trainJob:logExport | Write | trainJob \* | - | - | - | #### URI GET /v2/{project_id}/training-jobs/{training_job_id}/tasks/{task_id}/logs/url 表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"，依次类推。 **默认取值**：不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 否 | String | **参数解释**：消息体的类型。 **约束限制**：不涉及。 **取值范围**：枚举值如下： - text/plain：返回临时预览链接 - application/octet-stream：返回临时下载链接。 **默认取值**：不涉及。 | | start_time | 否 | Long | **参数解释**：日志查询起始时间。 **约束限制**：仅对开启日志分时下载的作业生效；分片包含该时间范围日志即命中。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | end_time | 否 | Long | **参数解释**：日志查询结束时间。 **约束限制**：仅对开启日志分时下载的作业生效；分片包含该时间范围日志即命中。 **取值范围**：不涉及。 **默认取值**：不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | obs_url | String | **参数解释**：日志OBS临时链接（复制到浏览器可查看当前全量日志）。 **取值范围**：不涉及。 | | shards | [Shards] object | **参数解释**：日志分片信息。 **取值范围**：不涉及。 | 表4Shards | 参数 | 参数类型 | 描述 | |:---|:---|:---| | object_urls | Array of strings | **参数解释**：日志分片的obs下载链接集。 **取值范围**：不涉及。 | | count | Integer | **参数解释**：本次请求返回的日志分片数。 **取值范围**：不涉及。 | | total | Integer | **参数解释**：本次请求命中的日志分片总数。 **取值范围**：不涉及。 | #### 请求示例 如下以查询uuid为2cd88daa-31a4-40a8-a58f-d186b0e93e4f的训练作业对应work-0日志OBS临时链接为例。 ``` GET https://{endpoint}/v2/{project_id}/training-jobs/2cd88daa-31a4-40a8-a58f-d186b0e93e4f/tasks/worker-0/logs/url ``` #### 响应示例 **状态码：200** ``` { "obs_url" : "http://192.0.2.1:20000/cnnorth4-test/xk/00chess_test/test11/logs/modelarts-job-0f2ccdbb-4f34-4d53-afb9-d526f3be8c68-ma-platform-init-worker-0-192.0.2.1-01909681.log?AWSAccessKeyId=xxxxx", "shards" : { "object_urls" : null, "count" : 0, "total" : 0 } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | ok | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。