查询agentRun的日志 - ListOpsAgentRunLog
功能介绍
该接口用于查询agentRun的日志。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| agentarts::listOpsAgentRunLog | List | - | - | - |
|
URI
GET /v1/ops/observation/agent-run/{agent_run_id}/log
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| agent_run_id | 是 | String | 参数解释: 智能体运行ID,用于标识单次智能体运行实例,可通过智能体运行记录或会话详情获取。 约束限制: 长度限制为1~64个字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| log_type | 是 | String | 参数解释: 日志类型,用来过滤日志查询中的task_type标签。 约束限制: 长度限制为1~64个字符。 取值范围: 不涉及。 默认取值: 默认为agent,查询智能体调用链相关日志。 |
| resource_type | 否 | String | 参数解释: 智能体类型。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| user_id | 否 | String | 参数解释: 用户id,兼容officeclaw场景传用户id,获取方式在控制台右上角“我的凭证”中复制得到。 约束限制: 不涉及。 取值范围: 不涉及 默认取值: 不涉及。 |
| start_time | 是 | String | 参数解释: 查询日志的开始时间,13位毫秒级时间戳(ms)。 约束限制: 必须与end_time同时使用,start_time不能晚于end_time。 取值范围: 由数字组成的13位毫秒级时间戳。 默认取值: 不涉及。 |
| end_time | 是 | String | 参数解释: 查询日志的结束时间,13位毫秒级时间戳(ms)。 约束限制: 由数字组成,必须为13位毫秒级时间戳,单位为毫秒。 取值范围: 不涉及。 默认取值: 不涉及。 |
| limit | 否 | Integer | 参数解释: 每次返回的数量,用于分页查询时指定每页记录数。 约束限制: 不涉及。 取值范围: 0~1000。 默认取值: 默认值为50。 |
| scroll_id | 否 | String | 参数解释: 分页查询滚动ID,若上次查询的返回结果中包含字段scrollId,需要增加该字段参与分页查询以获取下一页数据。 约束限制: 长度限制为1~64个字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
| keyword | 否 | String | 参数解释: 关键字查询,用于在日志内容中搜索包含指定关键字的日志记录。 约束限制: 长度限制为1~64个字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
| line_num | 否 | String | 参数解释: 日志行号,用于分页查询时指定起始行位置。首次查询时无需传入,后续查询时传入上次查询结果中最后一条日志的line_num以获取下一页数据。 约束限制: 长度限制为1~64个字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
| is_desc | 否 | Boolean | 参数解释: 表示日志查询的顺序。 约束限制: 长度限制为1~64个字符。 取值范围: 默认取值: 默认值为false。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| count | Integer | 参数解释: 返回查询日志总条数。 取值范围: 条数范围0~1000000。 |
| is_query_complete | Boolean | 参数解释: 是否查询出所有日志。 取值范围: 不涉及。 |
| logs | Array of AgentLogContent objects | 参数解释: 日志内容列表,元素类型为AgentLogContent对象,包含日志内容、行号、标签等信息。 取值范围: 不涉及。 |
| scroll_id | String | 参数解释: 分页查询的滚动ID,用于获取下一页数据,首次查询不返回此字段。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| content | String | 参数解释: 日志内容。 取值范围: 不涉及。 |
| line_num | String | 参数解释: 日志单行序列号。 取值范围: 不涉及。 |
| labels | Map<String,String> | 日志标签,Map类型。Key:标签名称,类型为String;Value:标签值,类型为String。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权信息,用于客户端解析权限问题。 取值范围: 不涉及。 |
| details | Array of OpsObserverCommonError objects | 参数解释: 赖的下游服务错误信息列表。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
请求示例
GET https://api.example.com/v1/ops/observation/agent-run/9cddb31b438f30e9/log?log_type=agent&limit=100&start_time=1775871365836&end_time=1775874965836
响应示例
状态码:200
参数解释:
响应码,用于标识接口调用结果。
取值范围:
200表示成功,其他值表示失败,具体参见错误码文档。
{
"count" : 10,
"is_query_complete" : true,
"logs" : [ {
"content" : "日志内容",
"line_num" : "1775871365836000",
"labels" : { }
} ],
"scroll_id" : "111"
} 状态码:400
参数解释:
响应码,用于标识接口调用结果。
取值范围:
400表示请求参数不正确。
{
"error_code" : "AgentArts.05001003",
"error_msg" : "请求参数不正确"
} 状态码:403
参数解释:
响应码,用于标识接口调用结果。
取值范围:
403表示权限不足,拒绝访问。
{
"error_code" : "AgentArts.05004003",
"error_msg" : "权限不足,拒绝访问",
"encode_authorization_message" : "eyJIcnJvciI6ICJVbmF1dGhvcm16ZWQifQ==",
"details" : [ {
"error_code" : "AgentArts.05001003"
}, {
"error_msg" : "请求参数不正确"
} ]
} 状态码:500
参数解释:
响应码,用于标识接口调用结果。
取值范围:
500表示内部服务器错误。
{
"error_code" : "AgentArts.05005000",
"error_msg" : "内部服务器错误"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 参数解释: 响应码,用于标识接口调用结果。 取值范围: 200表示成功,其他值表示失败,具体参见错误码文档。 |
| 400 | 参数解释: 响应码,用于标识接口调用结果。 取值范围: 400表示请求参数不正确。 |
| 403 | 参数解释: 响应码,用于标识接口调用结果。 取值范围: 403表示权限不足,拒绝访问。 |
| 500 | 参数解释: 响应码,用于标识接口调用结果。 取值范围: 500表示内部服务器错误。 |
错误码
请参见错误码。