文档中心

应用性能监控全链路版

Trace 分析

ListExportTasks

分页获取 Trace Span 导出任务列表。

请求说明

应用性能监控已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地选择最合适的接入点。

请求方式：POST

请求地址：https://apmplus-server.cn-beijing.volcengineapi.com?Action=ListExportTasks&Version=2024-07-30

请求参数

下方仅列出该接口特有的请求参数和部分公共参数，更多详细信息参见公共参数。

参数	类型	是否必选	示例值	描述
Action	String	是	ListExportTasks	接口名称。当前 API 的名称为 ListExportTasks。
Version	String	是	2024-07-30	接口版本。当前 API 的版本为 2024-07-30。
PageNumber	Integer	否	1	页码。
PageSize	Integer	否	10	每页数量。
OrderBy	String	否	CreatedAt	排序字段。取值： CreatedAt：创建时间 UpdatedAt：更新时间（默认值）
Order	String	否	Desc	排序方向。取值： ASC：升序排列 DESC：降序排列（默认值）
Filters	Object of ExportTaskFilters	否	{"Status":0,"ExportTarget":2,"Name":" OnlineExportTaskA"}	过滤条件。

ExportTaskFilters

参数	类型	是否必选	示例值	描述
Id	String	否	123	任务 ID。
Name	String	否	OnlineExportTaskA	任务名称。
Status	Integer	否	0	任务状态。取值： 0：待执行 1：运行中 2：已暂停 3：已完成 4：已删除 5：导出失败说明未传入时，返回所有状态的任务。
ExportTarget	Integer	否	2	导出数据的目标平台。取值： 2：AgentKit 评测平台 3：DataFinder 评测平台说明未传入时，返回所有目标平台的任务。

请求示例

POST https://apmplus-server.cn-beijing.volcengineapi.com?Action=ListExportTasks&Version=2024-07-30​
{​
    "PageNumber": 1,​
    "PageSize": 10,​
    "OrderBy": "CreatedAt",​
    "Order": "Desc",​
    "Filters": "{\"Status\":0,\"ExportTarget\":2,\"Name\":\"\nOnlineExportTaskA\"}"​
}

返回参数

参数	类型	示例值	描述
Items	Array of ExportTask	[{"Id":"1","Name":"OnlineExportTaskA","Status":0}]	任务列表。
TotalCount	Long	100	总数。

ExportTask

参数	类型	示例值	描述
Id	String	1	任务 ID。
Name	String	OnlineExportTaskA	任务名称。
EndAt	Long	1675180799000	任务结束时间的时间戳，单位：毫秒。
Status	Integer	3	任务状态。取值： 0：待执行 1：运行中 2：已暂停 3：已完成 4：已删除 5：导出失败
StartAt	Long	1672502400000	任务开始时间的时间戳，单位：毫秒。
TaskType	Integer	0	任务类型。取值：0，在线任务。
CreatedAt	String	2023-01-01T00:00:00Z	创建时间。
CreatedBy	String	zhangsan	任务的创建者用户名。
UpdatedAt	String	2023-01-01T01:00:00Z	更新时间。
UpdatedBy	String	lisi	任务最近一次更新操作的执行者用户名。
SpanFilter	Object of SpanFilter	{"ProjectName":"default","Conditions":[]}	Span 过滤条件。
TaskConfig	Object of TaskConfig	{"DataLimit":10000,"IsCycle":true,"CycleInterval":1,"CycleTimeUnit":"day","CycleDataLimit":100,"CycleStartAt":"0-00:00:00","CycleEndAt":"0-23:59:59"}	任务的配置信息。
TaskDetail	Object of TaskDetail	{"SuccessCount":950,"FailureCount":50,"TotalCount":1000}	任务执行详情。
Description	String	Online export task example	任务描述。
ExportTarget	Integer	2	导出数据的目标平台。取值： 0：本地文件 1：CozeLoop 2：AgentKit 评测平台 3：DataFinder 评测平台
ExportSpanParam	Object of ExportSpanParam	{"ExportFormat":"mapping","FieldMappings":[{"TraceFieldKey":"trace_id","TraceFieldJsonPath":"$.trace_id","FieldSchema":{"Name":"trace_id","ContentType":"Text","IsRequired":true}}]}	导出 Span 配置。
EvaluationConfig	Object of EvaluationConfig	{"WorkspaceId":"ws-12345","IsNewEvaluationSet":true,"EvaluationSetName":"EvaluationSetA","ExportType":0,"FieldSchemas":[]}	评测配置。

SpanFilter

参数	类型	示例值	描述
ProjectName	String	default	项目名称。说明不配置时表示所有项目，响应中不返回该字段。

TaskConfig

参数	类型	示例值	描述
IsCycle	Boolean	true	是否循环。取值： true：循环 false：不循环（默认值）
DataLimit	Long	10000	数据上限。
CycleEndAt	String	3-14:00:00	循环窗口结束时间。示例： 0-HH:mm:ss：按天循环 D-HH:mm:ss：按周循环，其中 D 表示星期，取值范围为 1～7，依次对应周一至周日。
CycleStartAt	String	1-14:00:00	循环窗口开始时间。示例： 0-HH:mm:ss：按天循环 D-HH:mm:ss：按周循环，其中 D 表示星期，取值范围为 1～7，依次对应周一至周日。
CycleInterval	Long	1	循环周期。
CycleTimeUnit	String	week	循环时间单位。取值： day：天 week：周
CycleDataLimit	Long	100	单次循环数据量。

TaskDetail

参数	类型	示例值	描述
TotalCount	Long	1000	总导出量。
FailureCount	Long	50	失败数。
SuccessCount	Long	950	成功数。

ExportSpanParam

参数	类型	示例值	描述
ExportFormat	String	mapping	导出格式。取值： mapping：按字段映射规则导出 custom_template：按自定义模板结构导出 span_detail：按 Span 详情导出
FieldMappings	Array of 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 时，需要配置此参数。

FieldMappings

参数	类型	示例值	描述
FieldSchema	Object of FieldSchema	{"Name":"trace_id","Description":"Trace ID","ContentType":"Text","IsRequired":true}	目标评测集字段结构。
TraceFieldKey	String	trace_id	Trace 字段名称。示例值： GenAIInput：大模型输入内容字段 GenAIOutput：大模型输出内容字段 trace_id：链路追踪的标识符 span_id：单个调用单元的标识符 tags.type：Span 标签中的类型字段
TraceFieldJsonPath	String	$.trace_id	Trace 字段的 JSON 路径。

FieldSchema

参数	类型	示例值	描述
Name	String	trace_id	字段名称。
IsRequired	Boolean	true	字段是否必填。取值： true：必填 false：选填（默认值）
TextSchema	String	{"type":"string"}	文本字段的 JSON Schema 定义。
ContentType	String	Text	字段内容类型。
Description	String	Trace ID	字段描述。
DefaultDisplayFormat	String	plain_text	字段默认展示格式。

EvaluationConfig

参数	类型	示例值	描述
ExportType	Integer	0	导出方式。取值： 0：追加（默认值） 1：覆盖
WorkspaceId	String	ws-12345	评测平台工作空间 ID。
FieldSchemas	Array of FieldSchema	[{"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	是否创建新的评测集。取值： true：创建 false：不创建（默认值）

返回示例

{​
    "Result": {​
        "Items": [​
            {​
                "Id": "task-123456",​
                "Name": "OnlineExportTaskA",​
                "EndAt": 1675180799000,​
                "Status": 3,​
                "StartAt": 1672502400000,​
                "TaskType": 0,​
                "CreatedAt": "2023-01-01T00:00:00Z",​
                "CreatedBy": "zhangsan",​
                "UpdatedAt": "2023-01-01T01:00:00Z",​
                "UpdatedBy": "lisi",​
                "SpanFilter": {​
                    "ProjectName": "default"​
                },​
                "TaskConfig": {​
                    "IsCycle": true,​
                    "DataLimit": 10000,​
                    "CycleEndAt": "0-23:59:59",​
                    "CycleStartAt": "0-00:00:00",​
                    "CycleInterval": 1,​
                    "CycleTimeUnit": "day",​
                    "CycleDataLimit": 100​
                },​
                "TaskDetail": {​
                    "TotalCount": 1000,​
                    "FailureCount": 50,​
                    "SuccessCount": 950​
                },​
                "Description": "Online export task example",​
                "ExportTarget": 2,​
                "ExportSpanParam": {​
                    "ExportFormat": "mapping",​
                    "FieldMappings": [​
                        {​
                            "TraceFieldKey": "trace_id",​
                            "TraceFieldJsonPath": "$.trace_id",​
                            "FieldSchema": {​
                                "Name": "trace_id",​
                                "IsRequired": true,​
                                "TextSchema": "{\"type\":\"string\"}",​
                                "ContentType": "Text",​
                                "Description": "Trace ID",​
                                "DefaultDisplayFormat": "plain_text"​
                            }​
                        }​
                    ],​
                    "CustomTemplate": "{\"trace_id\":\"{{.TraceId}}\"}"​
                },​
                "EvaluationConfig": {​
                    "ExportType": 0,​
                    "WorkspaceId": "ws-12345",​
                    "FieldSchemas": [​
                        {​
                            "Name": "trace_id",​
                            "IsRequired": true,​
                            "TextSchema": "{\"type\":\"string\"}",​
                            "ContentType": "Text",​
                            "Description": "Trace ID",​
                            "DefaultDisplayFormat": "plain_text"​
                        }​
                    ],​
                    "EvaluationSetId": "eval-set-67890",​
                    "EvaluationSetName": "Trace Evaluation Set",​
                    "IsNewEvaluationSet": true​
                }​
            }​
        ],​
        "TotalCount": 1​
    },​
    "ResponseMetadata": {​
        "Action": "ListExportTasks",​
        "Region": "cn-north-1",​
        "Service": "apmplus_server",​
        "Version": "2024-07-30",​
        "RequestId": "20230604110420****100232280022D31"​
    }​
}

错误码

若接口调用返回异常，可参考以下接口错误码和公共错误码进行故障排查。

HTTP 状态码	错误码	错误信息	说明
500	ErrInternalServerError	We encountered an unexpected server error, please try again later.	服务器内部错误。

最近更新时间：2026.07.30 15:07:41

这个页面对您有帮助吗？

有用

无用