日志接口
更新时间:2024-07-02
日志接口
接口描述
获取命令执行的日志记录。
请求结构
POST /v1/ca/log
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
runId | String | 是 | RequestBody参数 | 执行ID |
childId | String | 是 | RequestBody参数 | 执行ID下某一子执行ID |
cursor | int | 是 | RequestBody参数 | 首次请求为0,后续翻页,填写上一次请求返回的nextCursor |
响应头域
除公共头域外,无其它特殊头域。
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
requestId | String | 请求id |
code | String | 响应状态,成功为success |
result | LogResult | 返回日志结果 |
请求示例
POST /v1/ca/log
{
"runId": "r-KJoCY9kKa9******",
"childId": "d-ks3GQL******",
"cursor": 0
}
响应示例
{
"requestId": "aaf4bd8f-ed6c-481b-ad1a-a4c974******",
"code": "success",
"result": {
"logs": [
{
"msg": "pwd \n",
}, {
"msg": "second line",
}
],
"nextCursor": 2,
"state" : "RUNNING"
}
}
附录
LogResult
参数名称 | 类型 | 描述 |
---|---|---|
childId | String | 子执行id |
logs | List<Log> | 日志内容,顺序排列 |
state | String | 子执行状态。枚举值:FAILED(执行失败),RUNNING(执行中),SUCCESS(执行完成) |
nextCursor | int | 下一次请求使用的cursor。若子执行已结束,且nextCursor=cursor,表示已无更多日志。否则,表示可能存在更多日志 |
Log
参数名称 | 类型 | 描述 |
---|---|---|
msg | String | 命令执行日志 |