工作空间资源任务状态查询¶

GET /api/v1/workspace/resource/query_action_status

概述¶

查询工作空间资源导入导出任务状态

Query 请求参数¶

参数名	类型	必选	说明
taskId	string	Y	任务ID 例子: task_xxx 允许为空: False

参数补充说明¶

1. 接口用途

查询工作空间资源导入或导出任务的执行状态。

返回结构与前台接口保持一致，适用于： - 导出任务结果查询 - 导入任务结果查询 - 错误码和失败信息查询

2. 常见状态值

状态值	说明
`start`	任务已创建，尚未开始执行
`running`	任务执行中
`ok`	任务执行成功
`error`	任务执行失败
`cancel`	任务已取消

3. 常见返回字段说明

字段名	说明
`status`	当前任务状态
`action`	任务类型，常见为 `import` 或 `export`
`message`	附加说明
`errorCode`	失败时的错误码
`import_info`	导入/导出统计和失败信息
`name_list`	某些任务附带的资源名称列表

4. 导出任务查询说明

导出任务成功后，状态通常为 ok，并可在返回结果中拿到导出文件相关信息。

若导出过程中有部分对象失败，可查看：

import_info.exportFailedInfo

5. 导入任务查询说明

导入任务成功后，通常可在 import_info 中看到：

successCount
failCount

某些资源的详细失败原因会体现在 errorCode 或导入任务内部错误统计中。

6. 轮询建议

建议每 2 到 5 秒轮询一次，直到状态变成： - ok - error - cancel

请求例子¶

curl 'https://openapi.guance.com/api/v1/workspace/resource/query_action_status?taskId=task_xxx' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed

响应¶

{
    "code": 200,
    "content": {
        "status": "ok",
        "action": "import",
        "message": "",
        "errorCode": "",
        "import_info": {
            "failCount": 0,
            "successCount": 12
        }
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}

工作空间资源任务状态查询¶

概述¶

Query 请求参数¶

参数补充说明¶

请求例子¶

响应¶

文档内容是否对您有帮助？ ×