POST https://ark.cn-beijing.volcengineapi.com/?Action=GetRecordExportTask&Version=2024-01-01
查询用量明细导出任务状态,并获取文件下载链接。
鉴权#
本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。
- Access Key 鉴权,请在 Access Key 管理 页面,获取 Access Key。本接口仅支持 Access Key 鉴权。
请求参数#
Body 参数#
Id string 必选 | 导出任务 ID
任务 ID,调用 CreateRecordExportTask 接口时返回的唯一任务标识,格式为 uet-YYYYMMDDhhmmss-<5 位字母数字>。
响应参数#
Task object | 任务完整状态
任务完整状态,包含任务进度、命中/导出行数及结果文件下载链接(仅在任务成功时返回)。
CreateTime number | 创建时间
Task.CreateTime
任务创建时间(UTC Unix 时间戳,单位:秒),即任务被提交并创建的时刻。
Id string | 任务 ID
Task.Id
任务 ID,与请求参数 Id 一致,方便并发查询时区分结果。
Status string | 任务状态
Task.Status
任务状态机。可取值:
Pending:任务已提交,等待调度Running:任务正在执行Succeeded:任务执行成功,可通过 DownloadUrl 下载结果Failed:任务执行失败,原因见 ErrorMessage
DownloadUrl string | 下载链接
Task.DownloadUrl
TOS 一次性签发的下载链接,仅当 Status 为 Succeeded 时存在有效值。
DownloadUrlExpireTime number | 链接过期时间
Task.DownloadUrlExpireTime
下载链接的过期时间(UTC Unix 时间戳,单位:秒),有效期 12 小时,过期后对应 TOS 文件将被清理。
EndTime number | 结束时间
Task.EndTime
任务结束时间(UTC Unix 时间戳,单位:秒)。代表任务进入 Succeeded、Failed 终态的时间;任务处理中时该字段不返回。
ErrorMessage string | 失败原因
Task.ErrorMessage
任务失败时的指引文案,仅当 Status 为 Failed 时存在有效值。
ExportCount number | 实际导出行数
Task.ExportCount
实际写入 CSV 文件的行数,最大不超过 100000。当 TotalCount 大于 ExportCount 时,表示导出结果因达到单任务行数上限而被截断。
最大值:100000
FileExpired number | 文件过期标识
Task.FileExpired
文件是否已过期的标识。当当前时间大于等于 DownloadUrlExpireTime 时为 true。
QueryParams string | 原始请求参数
Task.QueryParams
原始请求参数的 JSON 字符串,用于任务回放或审计。
StartTime number | 开始时间
Task.StartTime
任务开始时间(UTC Unix 时间戳,单位:秒),对应任务状态切换为 Running 的时刻。任务未调度时该字段不返回;若任务触发系统重试,此字段始终保留首次启动时间。
TotalCount number | 命中总行数
Task.TotalCount
查询命中的总行数,用于判断 ExportCount 是否因单任务 100000 行上限被截断。