GetPodLogs - 获取任务中某个节点的日志

更新时间:
复制 MD 格式

获取(或者下载)任务某个节点的日志,日志来源于系统和用户脚本的stdout和stderr。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

paidlc:GetPodLogs

get

*全部资源

*

无 无

请求语法

GET /api/v1/jobs/{JobId}/pods/{PodId}/logs HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

JobId

string

是

任务 ID。如何获取任务 ID,请参见 ListJobs 。

dlc-20210126170216-*****

PodId

string

是

节点 ID。如何获取节点 ID,请参见 GetJob 。

dlc-20210126170216-*****-chief-0

请求参数

名称

类型

必填

描述

示例值

PodUid

string

否

节点 UID;如何获取节点 UID,请参见 GetJob 。

fe846462-af2c-4521-bd6f-96787a57****

MaxLines

integer

否

返回的日志的最大行数,默认值:2000。

100

StartTime

string

否

查询的起始时间,默认值:7 天前。

2020-11-08T16:00:00Z

EndTime

string

否

查询的截止时间,默认值:当前。

2020-11-08T17:00:00Z

DownloadToFile

boolean

否

是否下载日志文件。取值如下:

  • false(默认):表示不下载日志文件。

  • true:开始下载日志文件。

true

Containers

string

否

筛选指定容器的日志,多个容器名称用,链接

pytorch,aimaster-worker

返回参数

名称

类型

描述

示例值

object

返回值。

ContainerInfo ContainerInfo

节点可能涉及到的容器信息

Containers

string

筛选日志的容器,多个容器名称用,连接

pytorch,aimaster-worker

JobId

string

任务 ID。

dlc-20210126170216-******

Logs

array

日志列表。

string

日志列表。

2021-01-28 14:07:45 My Job started.

PodId

string

节点 ID。

dlc-20210126170216-****-chief-0

PodUid

string

实例 UID。

94a7cc7c-0033-48b5-85bd-71c63592c268

RequestId

string

此次调用的请求 ID,用于诊断和答疑。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

{
  "ContainerInfo": {
    "MainContainer": "pytorch",
    "SidecarContainers": [
      "aimaster-worker"
    ]
  },
  "Containers": "pytorch,aimaster-worker",
  "JobId": "dlc-20210126170216-******",
  "Logs": [
    "2021-01-28 14:07:45  My Job started."
  ],
  "PodId": "dlc-20210126170216-****-chief-0",
  "PodUid": "94a7cc7c-0033-48b5-85bd-71c63592c268",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。