更新时间:2025-09-30 GMT+08:00
分享

查询全量日志

功能介绍

根据部署记录ID查询全量日志。

调用方法

请参见如何调用API

URI

GET /v1/applications/{app_id}/records/{record_id}/logs

表1 路径参数

参数

是否必选

参数类型

描述

app_id

String

参数解释

应用ID。通过调用获取应用列表接口获取(响应体result[0].id的值)。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

record_id

String

参数解释

部署记录ID。通过调用根据开始时间和结束时间查询项目下指定应用的历史部署记录列表接口获取(响应体result[0].execution_id的值)。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

String

参数解释

日志起始偏移量。

约束限制

不涉及。

取值范围

只能由数字组成,且长度为1-19个数字。

默认取值

不涉及。

end_offset

String

参数解释

日志末位偏移量。

约束限制

不涉及。

取值范围

只能由数字组成,且长度为1-19个数字。

默认取值

不涉及。

step_id

String

参数解释

部署步骤ID。通过调用获取应用详情接口获取(响应体result.arrange_infos[0].steps.step1.id的值)。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为1-32个字符。

默认取值

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制

不涉及。

取值范围

字符串,长度不超过20000个字符。

默认取值

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

result

Object

参数解释

部署应用日志记录结果。

取值范围

不涉及。

status

String

参数解释

查询日志结果。

取值范围

  • success: 查询日志成功。

  • error: 查询日志失败。

表5 QueryAppLogResult

参数

参数类型

描述

has_more

Boolean

参数解释

是否有更多日志信息。

取值范围

  • ture: 有更多日志,继续调用该接口还能查询到更多日志。

  • false: 无更多日志,继续调用该接口日志信息无变化。

text

String

参数解释

日志信息。

取值范围

不涉及。

offset

String

参数解释

日志起始偏移量。

取值范围

只能由数字组成。

end_offset

String

参数解释

日志末位偏移量,查询后续日志用于offset参数入参。

取值范围

只能由数字组成。

请求示例

根据部署记录ID查询全量日志。

https://{endpoint}/v1/applications/00105ecca9d142148f9807cf0cdebfef/records/03e60d39434648a2bb60cb8eb2817dde/logs?offset=0&end_offset=0

响应示例

状态码:200

OK,表示查询全量日志成功。

{
  "result" : {
    "has_more" : true,
    "text" : "[2024/09/26 10:57:37.290 GMT+08:00] [INFO]...",
    "offset" : "0",
    "end_offset" : "3354"
  },
  "status" : "success"
}

状态码

状态码

描述

200

OK,表示查询全量日志成功。

错误码

请参见错误码

相关文档