统一目录实体导出¶
GET /api/v1/unified_catalog/entity/export
概述¶
导出统一目录实体列表为 CSV，导出列以实体类型视图定义 viewDefine.layout 为准。
Query 请求参数¶
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| entityType | string | Y | 实体类型编码 允许为空: False |
| provider | string | 单个来源类型，多个值建议改传 filters 或 providers 场景接口 允许为空: False |
|
| search | string | 模糊搜索，匹配 urn / display_name / name 允许为空: False |
|
| filters | json | attributes 字段过滤，支持 JSON 对象或字符串化 JSON 允许为空: False 例子: {'env': ['prod']} |
|
| orderBy | string | 排序字段，默认 updatedAt 允许为空: False |
|
| order | string | 排序方式，默认 desc 允许为空: False |
参数补充说明¶
请求参数说明
| 参数名 | type | 必选 | 说明 |
|---|---|---|---|
| entityType | string | 是 | 实体类型编码，不同类型导出列不同 |
| provider | string | 否 | 单个来源类型 |
| search | string | 否 | 模糊搜索，匹配 urn / display_name / name |
| filters | json | 否 | attributes 字段过滤 |
| orderBy | string | 否 | 排序字段，默认 updatedAt |
| order | string | 否 | 排序方向，默认 desc |
调用注意事项
- 导出列以实体类型视图定义
viewDefine.layout为准。 filters支持 JSON 对象或字符串化 JSON。- 接口成功后直接返回 CSV 文件流，建议调用方以文件下载方式处理。
请求例子¶
curl 'https://openapi.guance.com/api/v1/unified_catalog/entity/export?entityType=database&filters={"env":["prod"]}' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--output entities.csv