查询调用链详细信息 - ShowOpsTrace
功能介绍
该接口用于查询调用链详细信息。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| agentarts::showOpsTrace | Read | - | - | - |
|
URI
GET /v1/ops/observation/traces/{trace_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| trace_id | 是 | String | 参数解释: 调用链ID。 约束限制: 长度限制1-64位。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 参数解释: 消息体编码格式。用于告知服务端请求体(Body)所采用的主体数据类型,以便服务端正确解析。 约束限制: 不涉及。 取值范围: application/json。 默认取值: application/json。 |
| Authorization | 是 | String | 参数解释: 签名认证信息,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。 约束限制: SDK自动填充,格式为SDK-HMAC-SHA256。 取值范围: 符合签名规范的字符串。 默认取值: 不涉及。 |
| X-Sdk-Date | 是 | String | 参数解释: 请求发送的时间,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。 约束限制: 符合ISO 8601格式。 取值范围: 格式为YYYYMMDDTHHMMSSZ,如20240416T095341Z。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 参数解释: 总数。 取值范围: 不涉及。 |
| span_list | Array of SpanInfo objects | 参数解释: Span列表,包含查询到的所有Span数据。 取值范围: 数组中的每个元素为SpanInfo对象。" |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| trace_id | String | 参数解释: 调用链ID,唯一标识一次完整的调用链。 取值范围: 由系统生成的唯一标识字符串。 |
| parent_span_id | String | 参数解释: 父节点SpanID,标识当前Span的父节点。 取值范围: SpanID字符串或null(根节点)。" |
| span_id | String | 参数解释: SpanID,唯一标识当前Span。 取值范围: 由系统生成的唯一标识字符串。 |
| span_type | String | 参数解释: Span类型,标识当前Span所属的类型。 取值范围: 不涉及。 |
| span_name | String | 参数解释: Span名称,标识当前Span的操作名称。 取值范围: 不涉及。 |
| status_code | String | 参数解释: 状态码,标识当前Span的执行状态。 取值范围: 不涉及。 |
| input | String | 参数解释: 输入。 取值范围: 不涉及。 |
| output | String | 参数解释: 输出。 取值范围: 不涉及。 |
| duration | Integer | 参数解释: 耗时,当前Span的执行时长。 取值范围: 大于等于0的整数,单位为ms。 |
| session_id | String | 参数解释: 会话ID。 取值范围: 不涉及。 |
| tokens | Integer | 参数解释: Tokens消耗,当前Span消耗的总Token数量。 取值范围: 大于等于0的整数,单位为个。 |
| input_tokens | Integer | 参数解释: Input Tokens消耗,当前Span输入部分消耗的Token数量。 取值范围: 大于等于0的整数,单位为个。 |
| output_tokens | Integer | 参数解释: Output Tokens消耗,当前Span输出部分消耗的Token数量。 取值范围: 不涉及。 |
| start_time | Long | 参数解释: 开始时间,当前Span开始执行的时间戳。 取值范围: Unix时间戳,单位为ms。 |
| call_type | String | 参数解释: 触发类型。 取值范围: 不涉及。 |
| metadata | String | 参数解释: 元数据。 取值范围: 不涉及。 |
| feedback_operation | String | 参数解释: 评价状态,标识当前Span的用户评价。 取值范围: |
| label | Array of Label objects | 参数解释: 标签组,当前Span关联的所有标签信息。 |
| resource_id | String | 参数解释: 应用ID,当前Span所属应用的唯一标识。 取值范围: 应用ID字符串。 |
| resource_name | String | 参数解释: 应用名称,当前Span所属应用的名称。 取值范围: 不涉及。 |
| resource_type | String | 参数解释: 应用类型,当前Span所属应用的类型。 取值范围: |
| model_name | String | 参数解释: 模型名称,当前Span使用的模型名称。 取值范围: 不涉及。 |
| is_error | Boolean | 参数解释: 是否失败,标识当前Span是否执行失败。 取值范围: |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| trace_id | String | 参数解释: 调用链ID,标签所属的调用链唯一标识。 取值范围: 调用链ID字符串。 |
| span_id | String | 参数解释: SpanID,标签所属的Span唯一标识。 取值范围: SpanID字符串。 |
| start | Long | 参数解释: 开始时间,标签创建或关联的时间戳。 取值范围: Unix时间戳,单位为ms。 |
| last_update_time | Long | 参数解释: 更新时间,标签最后更新的时间戳。 取值范围: Unix时间戳,单位为ms。 |
| label | String | 参数解释: 标签名称,标签的标识名。 取值范围: 不涉及。 |
| string_value | String | 参数解释: 标签值,当标签值为字符串类型时返回此字段。 取值范围: 字符串值。 |
| float_value | String | 参数解释: 标签值,当标签值为浮点数类型时返回此字段。 取值范围: 浮点数值的字符串表示。 |
请求示例
GET https://*.com/v1/ops/observation/traces/5af65999f08e136b0963253064a2f693 Content-Type:application/json X-Sdk-Date:20240416T095341Z Authorization:SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************
响应示例
状态码:200
参数解释:
响应码,用于标识接口调用结果。
取值范围:
200表示成功,其他值表示失败,具体参见错误码文档。
{
"span_list" : [ {
"trace_id" : "94c7408e75f61939f1deb09b58a1baf1",
"parent_span_id" : null,
"span_id" : "7176c7f41140760d",
"span_type" : "workflow",
"span_name" : "UserInput",
"status_code" : "STATUS_CODE_OK",
"input" : "10000000000美元可以兑换黄金",
"output" : "10000000000美元可以兑换黄金",
"duration" : 5,
"session_id" : "test111",
"tokens" : 0,
"input_tokens" : 0,
"output_tokens" : 0,
"start_time" : 1775271188055,
"call_type" : "debug",
"metadata" : null,
"feedback_operation" : null,
"label" : { },
"resource_id" : "b0fd244b-c5c8-4ef7-97b6-645a1b03edc6",
"resource_name" : "测试",
"resource_type" : "workflow",
"model_name" : null,
"is_error" : false
} ],
"total" : 5
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 参数解释: 响应码,用于标识接口调用结果。 取值范围: 200表示成功,其他值表示失败,具体参见错误码文档。 |
错误码
请参见错误码。