跳转至

工作空间资源导出



POST /api/v1/workspace/resource/export/task/create

概述

发起工作空间资源导出任务

参数补充说明

1. 接口用途

发起当前工作空间的资源导出任务。

该接口是异步任务接口,调用成功后只会返回 taskId,不会立即返回压缩包内容。

调用流程建议如下:

  1. 调用当前接口,获取 taskId
  2. 调用 GET /api/v1/workspace/resource/query_action_status 轮询任务状态
  3. 当状态变为 ok 后,从状态接口返回结果中获取导出文件信息

2. 请求说明

默认不传请求体时导出 DF-API-KEY 所属工作空间的全部资源。

如需导出 SLO 资源包,请调用 POST /api/v1/slo/export/task/create;当前接口仅用于导出工作空间全量资源。


3. 返回说明

成功返回示例:

{
  "taskId": "task_xxx"
}

说明:

  • 只要创建任务成功,就会返回 taskId
  • 后续导出执行失败、部分资源导出失败,都需要通过任务状态接口查看

4. 当前资源边界说明

当前工作空间资源导入导出有以下边界:

  1. 环境变量不包含 scope=rum
  2. 日志索引不包含外部索引和 default
  3. 字段管理只处理工作空间自定义字段
  4. 数据访问当前不支持工作空间导入导出

5. 导出结果补充说明

如果某个资源中的单个对象导出失败,不会中断整个导出任务。 任务状态接口的 import_info.exportInfo.resourceFailureInfo 返回去重后的资源级失败明细,包括资源类型、资源 UUID、资源名称、稳定失败原因和受影响 SLO;不返回资源配置、权限成员、异常堆栈或敏感字段。 旧的 import_info.exportFailedInfo 继续保留用于兼容旧客户端,但不建议直接展示其中的原始异常信息。

请求例子

curl 'https://openapi.guance.com/api/v1/workspace/resource/export/task/create' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed

响应

{
    "code": 200,
    "content": {
        "taskId": "task_xxx"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
} 

文档评价

文档内容是否对您有帮助?