更新时间:2025-03-10 GMT+08:00
分享

API导出资源包

功能介绍

API导出资源包。

URI

POST /v1/{project_id}/resource-package/export

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

获取方法请参考获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Workspace-Id

String

工作空间ID。获取方法请参见获取工作空间ID

X-Auth-Token

String

用户Token。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

导出包名称。

export_param

ResourcePackageExportParam object

导出高级参数。

resources

Array of objects

导出资源明细。

表4 ResourcePackageExportParam

参数

是否必选

参数类型

描述

export_dataset_tag_permission

Boolean

是否携带数据集行权限-标签授权。

表5 resources

参数

是否必选

参数类型

描述

resource_type

String

参数解释:

资源类型枚举值,用于指定授权对象的类型。

示例:datasource,指定授权对象类型为数据源。

约束限制:

不涉及

取值范围:

以下枚举值:

  • datasource:数据源;
  • dataset:数据集;
  • metric:指标;
  • dashboard:仪表板;
  • screen:大屏;
  • embedAnalysis:嵌入分析;
  • portal:数据门户;
  • subject:智能分析助手。

默认取值:

不涉及

resource_id

String

资源ID。

响应参数

表6 响应Body参数

参数

参数类型

描述

-

File

文件流。

请求示例

POST https://{endpoint}/v1/{project_id}/resource-package/export
{
  "name" : "未命名资源包",
  "resources" : [ {
    "resource_type" : "datasource",
    "resource_id" : "12awedqweqweqwe"
  } ]
}

响应示例

无。

状态码

表7 状态码

状态码

描述

200

文件流。

错误码

请参见错误码

相关文档