应用性能监控全链路版
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Action | String | 是 | ExportTraceSpan | 接口名称。当前 API 的名称为 ExportTraceSpan。 |
Version | String | 是 | 2024-07-30 | 接口版本。当前 API 的版本为 2024-07-30。 |
SpanListParam | 是 | {"StartTime":1672502400,"EndTime":1672506000,"SpanIds":["0af7651916cd43dd8448eb211c80319c"]} | 待导出的 Span 查询条件。 | |
ExportSpanParam | 是 | {"ExportFormat":"mapping","FieldMappings":[{"TraceFieldKey":"trace_id","TraceFieldJsonPath":"$.trace_id","FieldSchema":{"Name":"trace_id","ContentType":"Text","IsRequired":true}}]} | Span 导出格式与字段映射配置。 | |
ExportTarget | Integer | 是 | 2 | 导出目标。取值:
|
EvaluationConfig | 是 | {"WorkspaceId":"ws-12345","IsNewEvaluationSet":true,"EvaluationSetName":" EvaluationSetA","ExportType":0,"FieldSchemas":[]} | 统一评测平台配置。 | |
ProjectName | String | 是 | default | 项目名称。 |
CozeToken | String | 是 | pat_xxx | 访问 CozeLoop 的授权令牌。 说明 当查询 CozeLoop时,必须配置此参数。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Limit | Integer | 否 | 100 | 导出数量上限。 |
Order | String | 否 | DESC | 排序方向。取值:
|
Offset | Integer | 否 | 0 | 导出数据偏移量。 |
EndTime | Long | 否 | 1672506000 | 查询结束时间戳,单位:秒。 |
Filters | 否 | [{"Key":"service_name","Op":"in","Values":["checkout-service"]}] | Span 过滤条件。 | |
OrderBy | String | 否 | start_time_millisecond | 排序字段。示例:
|
SpanIds | Array of String | 否 | ["0af7651916cd43dd8448eb211c80319c"] | 指定导出的 Span ID 列表。 |
StartTime | Long | 否 | 1672502400 | 查询开始时间戳,单位:秒。 |
MaxCallCostMillisecond | Long | 否 | 1000 | 调用耗时上限,单位:毫秒。 说明 取值为 0 时,表示不限制该参数。 |
MinCallCostMillisecond | Long | 否 | 0 | 调用耗时下限。单位:毫秒。 说明 取值为 0 时,表示不限制该参数。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Op | String | 否 | in | 过滤条件操作符。取值:
|
Key | String | 否 | session_id | 过滤条件 Key。 |
Values | Array of String | 否 | ["sess_001"] | 过滤条件值。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
ExportFormat | String | 否 | mapping | 导出格式。取值:
|
FieldMappings | 否 | [{"TraceFieldKey":"trace_id","TraceFieldJsonPath":"$.trace_id","FieldSchema":{"Name":"trace_id","ContentType":"Text","IsRequired":true}}] | 字段映射。 说明 仅在 ExportFormat取值为 mapping 时,需要配置此参数。 | |
CustomTemplate | String | 否 | {"trace_id":"{{.TraceId}}"} | 自定义导出模板。 说明 仅在 ExportFormat取值为 custom_template 时,需要配置此参数。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
FieldSchema | 否 | {"Name":"trace_id","Description":"Trace ID","ContentType":"Text","IsRequired":true} | 目标评测集字段结构。 | |
TraceFieldKey | String | 否 | trace_id | Trace 字段名称。示例值:
|
TraceFieldJsonPath | String | 否 | $.trace_id | Trace 字段的 JSON 路径。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Name | String | 否 | trace_id | 字段名称。 |
IsRequired | Boolean | 否 | true | 字段是否必填。 |
TextSchema | String | 否 | {"type":"string"} | 文本字段的 JSON Schema 定义。 |
ContentType | String | 否 | Text | 字段内容类型。 |
Description | String | 否 | Trace ID | 字段描述。 |
DefaultDisplayFormat | String | 否 | plain_text | 字段默认展示格式。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
ExportType | Integer | 否 | 0 | 导出方式。取值:
|
WorkspaceId | String | 否 | ws-12345 | 评测平台工作空间 ID。 |
FieldSchemas | 否 | [{"Name":"trace_id","Description":"Trace ID","ContentType":"Text","IsRequired":true}] | 评测集字段结构列表。 | |
EvaluationSetId | String | 否 | eval-set-67890 | 已有评测集 ID。 说明 当 IsNewEvaluationSet取值为 false 时,必须配置此参数。 |
EvaluationSetName | String | 否 | Trace Evaluation Set | 新评测集名称。 说明 当 IsNewEvaluationSet取值为 true 时,必须配置此参数。 |
IsNewEvaluationSet | Boolean | 否 | true | 是否创建新的评测集。取值:
|
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
Items | [{"FieldList":[],"status":"success"}] | 导出的数据项列表。 | |
ItemCount | Integer | 100 | 成功生成的导出数据项数量。 |
EvaluationSetId | String | eval-set-67890 | 写入的评测集 ID。 |
EvaluationSetName | String | Trace Evaluation Set | 写入的评测集名称。 |
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
status | String | success | 数据项导出状态。 |
FieldList | [{"Key":"trace_id","Name":"trace_id","Content":{"ContentType":"Text","Text":"0af7651916cd43dd8448eb211c80319c"}}] | 数据项字段列表。 |
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
Key | String | trace_id | 字段唯一标识。 |
Name | String | trace_id | 字段名称。 |
Content | {"ContentType":"Text","Text":"0af7651916cd43dd8448eb211c80319c"} | 字段内容。 |
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
Text | String | 0af7651916cd43dd8448eb211c80319c | 文本内容。 |
ContentType | String | Text | 字段内容类型。 |
HTTP 状态码 | 错误码 | 错误信息 | 说明 |
HTTP 状态码 | 错误码 | 错误信息 | 说明 |
500 | ErrInternalServerError | We encountered an unexpected server error, please try again later. | 服务器内部错误。 |