TI-ONE 训练平台
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > TI-ONE 训练平台 > API 文档 > 查看日志相关接口 > 获取日志

获取日志

最近更新时间：2024-03-12 01:55:53

我的收藏

本页目录：

1. 接口描述

接口请求域名： tione.tencentcloudapi.com 。

获取任务式建模训练任务，Notebook，在线服务和批量预测任务的日志API

默认接口请求频率限制：20次/秒。

此接口支持如下压缩格式返回：gzip

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeLogs。
Version 是 String 公共参数，本接口取值：2021-11-11。
Region 是 String 公共参数，详见产品支持的 地域列表。
Service 是 String 服务类型，TRAIN为任务式建模, NOTEBOOK为Notebook, INFER为在线服务, BATCH为批量预测
枚举值：
- TRAIN
- NOTEBOOK
- INFER
- BATCH
示例值：TRAIN
StartTime 否 String 日志查询开始时间（RFC3339格式的时间字符串），默认值为当前时间的前一个小时
示例值：2021-11-30T16:22:09+08:00
EndTime 否 String 日志查询结束时间（RFC3339格式的时间字符串），默认值为当前时间
示例值：2021-11-30T16:22:09+08:00
Limit 否 Integer 日志查询条数，默认值100，最大值100
示例值：100
ServiceId 否 String 服务ID，和Service参数对应，不同Service的服务ID获取方式不同，具体如下：
- Service类型为TRAIN：
调用DescribeTrainingTask接口查询训练任务详情，ServiceId为接口返回值中Response.TrainingTaskDetail.LatestInstanceId
- Service类型为NOTEBOOK：
调用DescribeNotebook接口查询Notebook详情，ServiceId为接口返回值中Response.NotebookDetail.PodName
- Service类型为INFER：
调用DescribeModelServiceGroup接口查询服务组详情，ServiceId为接口返回值中Response.ServiceGroup.Services.ServiceId
- Service类型为BATCH：
调用DescribeBatchTask接口查询跑批任务详情，ServiceId为接口返回值中Response.BatchTaskDetail.LatestInstanceId
示例值：train-fsdjl-1
PodName 否 String Pod的名称，即需要查询服务对应的Pod，和Service参数对应，不同Service的PodName获取方式不同，具体如下：
- Service类型为TRAIN：
调用DescribeTrainingTaskPods接口查询训练任务pod列表，PodName为接口返回值中Response.PodNames
- Service类型为NOTEBOOK：
调用DescribeNotebook接口查询Notebook详情，PodName为接口返回值中Response.NotebookDetail.PodName
- Service类型为INFER：
调用DescribeModelService接口查询单个服务详情，PodName为接口返回值中Response.Service.ServiceInfo.PodInfos
- Service类型为BATCH：
调用DescribeBatchTask接口查询跑批任务详情，PodName为接口返回值中Response.BatchTaskDetail. PodList
注：支持结尾通配符*
示例值：train-fsdjl-1
Order 否 String 排序方向（可选值为ASC, DESC ），默认为DESC
示例值：DESC
OrderField 否 String 按哪个字段排序（可选值为Timestamp），默认值为Timestamp
示例值：Timestamp
Context 否 String 日志查询上下文，查询下一页的时候需要回传这个字段，该字段来自本接口的返回
示例值：aaa-bbb-ccc
Filters.N 否 Array of Filter 过滤条件
注意:
1. Filter.Name：目前只支持Key（也就是按关键字过滤日志）
2. Filter.Values：表示过滤日志的关键字；Values为多个的时候表示同时满足
3. Filter. Negative和Filter. Fuzzy没有使用

3. 输出参数

参数名称 类型 描述
Context String 分页的游标
注意：此字段可能返回 null，表示取不到有效值。
示例值：aaa-bbb-ccc
Content Array of LogIdentity 日志数组
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取日志

获取TI平台各种服务（训练，Notebook，推理等）的日志

输入示例

POST / HTTP/1.1
Host: tione.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLogs
<公共请求参数>

{
    "Service": "INFER",
    "StartTime": "2022-01-10T12:15:03+08:00",
    "Limit": 100,
    "PodName": "ms-cp6rgw9r-1*",
    "EndTime": "2022-01-11T12:15:03+08:00"
}

输出示例

{
    "Response": {
        "Content": [
            {
                "Id": "77b5d420-73bc-47f2-96ab-3a2b32262ffe",
                "Message": "This is a log",
                "PodName": "ms-cp6rgw9r-1-864587bdb4-p5cv6",
                "Timestamp": "2022-01-11T04:14:36.348499491Z"
            }
        ],
        "RequestId": "305ce475-e534-4cad-a4ab-a472a27ca3fd",
        "Context": "Y29udGV4dC0wYTdiNTRkMi0xOGI0LTQwNzEtYjIzYy1kZDE4NmM2NDFjNTIxNjQxODc0NTA2MTE5"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
中国站