edfialliance/ods-api-publisher

edfialliance

Ed-Fi API Publisher是用于在同一版本Ed-Fi ODS API实例间移动数据和变更的工具，作为标准API客户端运行，无需特殊网络配置或直接数据库访问，支持Pull、Push和Publishing部署模型，利用Change Queries实现首次全量同步及后续增量同步。

下载次数: 0状态：社区镜像维护者：edfialliance仓库类型：镜像最近更新：5 小时前

让 AI 帮你使用轩辕镜像？ · 展开查看说明

如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。

只需在 AI 对话中先发送下面这段话即可：

请先阅读并遵守：https://xuanyuan.cloud/agents.md

未读文档前不要生成 pull 命令或排错方案。

查看 agents.md 用法指南与完整示范。国内用户首推元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。若 AI 无法访问外链，可打开说明文档复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。

镜像标签列表与下载命令

Ed-Fi API Publisher

概述

Ed-Fi API Publisher是一款实用工具，用于在同一版本的Ed-Fi ODS API实例之间移动数据和变更。它作为标准API客户端对两个API端点（源和目标）进行操作，因此不需要特殊的网络配置、直接的ODS数据库访问或特定的数据库引擎。从数据安全/隐私角度来看，它还需遵守与其通信的Ed-Fi ODS API端点执行的所有授权机制。

核心功能和特性

跨实例数据同步：在同一版本的Ed-Fi ODS API实例间移动数据和变更
灵活部署模型：支持三种部署模型
- Pull模型：部署在目标（中央）API旁，从多个源API收集数据
- Push模型：部署在源API旁，将数据推送到中央目标
- Publishing模型：部署在源API旁，将数据推送到多个目标（如州教育机构和协作组织）
增量同步能力：若源API支持"Change Queries"功能，首次运行时执行全量数据发布，后续运行仅发布变更数据
状态跟踪：自动为每个源/目标组合在配置存储中维护已发布到特定目标的变更版本
安全合规：遵循Ed-Fi ODS API端点的所有授权机制

使用场景和适用范围

教育机构间的数据共享与同步
多区域教育数据中心的数据聚合
从多个学校或学区收集数据到中央教育机构
向多个监管机构或合作伙伴推送标准化教育数据
教育数据备份与灾备恢复

使用方法和配置说明

环境要求

源和目标Ed-Fi ODS/API必须为相同版本
目标ODS需配置具有适当发布权限的API客户端
运行环境需安装.NET 8.0

配置本地沙箱环境

在目标ODS上使用API Publisher前，必须创建并配置具有适当发布权限的API客户端。

对于Ed-Fi ODS / API 5.1至5.3版本：通过运行以下数据库脚本创建并分配API Publisher的声明集：

Create-API-Publisher-Writer-Security-Metadata.sql
Configure-Minimal-Sandbox-Client-as-API-Publisher-Writer.sql

使用API Publisher的三种方式

方式1 - 从二进制文件

下载最新发布的API Publisher包：https://dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_artifacts/feed/EdFi/NuGet/EdFi.ApiPublisher/overview/1.3.0，访问页面并点击下载。
将下载的NuGet包重命名为.zip扩展名：EdFi.ApiPublisher.1.3.0.nupkg → EdFi.ApiPublisher.1.3.0.zip。
二进制文件位于EdFi.ApiPublisher.Win64文件夹中，文件名为EdFiApiPublisher.exe。

方式2 - 从Docker镜像

Ed-Fi API Publisher的Docker镜像可在Docker Hub获取：https://hub.docker.com/r/edfialliance/ods-api-publisher/tags。可将其包含在Docker环境中，与Ed-Fi堆栈的其他组件一起使用。

Docker运行示例：

bash
docker run -it docker.xuanyuan.run/edfialliance/ods-api-publisher:v1.3.0 \
  --sourceUrl=https://api.ed-fi.org/v5.2/api/ \
  --sourceKey=RvcohKz9zHI4 \
  --sourceSecret=E1iEFusaNf81xzCxwHfbolkC \
  --targetUrl=http://localhost:54746/ \
  --targetKey=minimal_sandbox_API_key \
  --targetSecret=minimal_sandbox_API_secret \
  --ignoreIsolation=true \
  --maxDegreeOfParallelismForPostResourceItem=5 \
  --maxDegreeOfParallelismForStreamResourcePages=3 \
  --includeDescriptors=true \
  --exclude=surveys

方式3 - 从源代码构建

若要从源代码构建API Publisher，在存储库根目录运行以下命令构建解决方案：

bash
dotnet build

API Publisher可执行文件（EdFiApiPublisher.exe）将位于.\EdFi.Tools.ApiPublisher.Cli\bin\Debug\net8.0子文件夹中。

发布数据到本地沙箱

重要提示： 修改API的安全元数据后，如果本地沙箱Ed-Fi ODS API已在运行，必须重启该服务。

首先，找到最小模板沙箱的API客户端的key/secret。可使用Sandbox Admin工具，或对EdFi_Admin数据库运行以下查询：

sql
SELECT  [Key], [Secret]
FROM    docker.xuanyuan.run/EdFi_Admin.dbo.ApiClients
WHERE   Name = 'Minimal Demonstration Sandbox'

以下表格显示用于发布的命令行参数：

注意：由于快速启动配置的特性（假设SQL Server和Ed-Fi-ODS API在本地开发机器上运行），我们将POST请求的并行度限制为5。具有专用API和数据库资源的架构应能支持更高的数值。

参数		值
`--sourceUrl`	`=`	`https://api.ed-fi.org/v5.2/api/`
`--sourceKey`	`=`	`RvcohKz9zHI4`
`--sourceSecret`	`=`	`E1iEFusaNf81xzCxwHfbolkC`
`--targetUrl`	`=`	`http://localhost:54746/`
`--targetKey`	`=`	(最小沙箱API的_key_)
`--targetSecret`	`=`	(最小沙箱API的_secret_)
`--ignoreIsolation`	`=`	`true`
`--maxDegreeOfParallelismForPostResourceItem`	`=`	`5`
`--maxDegreeOfParallelismForStreamResourcePages`	`=`	`3`
`--includeDescriptors`	`=`	`true`
`--exclude`	`=`	`surveys`

在包含所有二进制文件的文件夹中运行Ed-Fi API Publisher，执行以下命令，替换为自己的API客户端key和secret：

bash
.\EdFiApiPublisher.exe --sourceUrl=https://api.ed-fi.org/v5.2/api/ --sourceKey=RvcohKz9zHI4 --sourceSecret=E1iEFusaNf81xzCxwHfbolkC --targetUrl=http://localhost:54746/ --targetKey=minimal_sandbox_API_key --targetSecret=minimal_sandbox_API_secret --ignoreIsolation=true --maxDegreeOfParallelismForPostResourceItem=5 --maxDegreeOfParallelismForStreamResourcePages=3 --includeDescriptors=true --exclude=surveys

仅Ed-Fi ODS API v5.2注意：--exclude标志用于防止尝试移动任何调查数据，这是由于Ed-Fi ODS API v5.2版本中的安全元数据问题（在https://tracker.ed-fi.org/browse/ODS-4974中描述）。如果删除此参数，发布操作将因数据中的依赖项未满足而失败。此问题已在ODS/API平台的后续版本中修复。

有关API Publisher参数的更多文档，请参阅API Publisher配置 markdown文件了解其他运行时选项。

有关键变更和删除的更多信息，请参阅键变更和删除的注意事项。

Ed-Fi ODS / API 5.1至5.3的已知限制

目前，Ed-Fi ODS / API 5.1至5.3存在以下与Change Queries和Ed-Fi API Publisher相关的已知问题。这些问题已在Ed-Fi ODS / API 5.3-cqe补丁和Ed-Fi ODS / API 6.1中解决。

https://tracker.ed-fi.org/browse/ODS-3672
https://tracker.ed-fi.org/browse/ODS-4423
https://tracker.ed-fi.org/browse/ODS-4087
https://tracker.ed-fi.org/browse/ODS-5005

（关于上述Ed-Fi ODS API问题解决需求的反馈，应通过https://support.ed-fi.org/提供给Ed-Fi联盟。）

Ed-Fi ODS/API仅公开已删除资源的"Id"，但由于"Id"并非旨在作为资源的全局可移植标识符（Ed-Fi使用域键值作为标识），因此当前删除资源的实现对于API发布的价值有限。

即使通过公开主键值添加了删除支持，由于Ed-Fi ODS API（至少到v5.3）的内部实现细节，仍无法跟踪和发布Descriptors的删除。

源API中（支持主键变更的API资源上的）主键变更目前会导致目标API中保留资源"旧"版本的过时副本（以及所有受影响的依赖项）。

Ed-Fi API Publisher的另一个限制是当前不支持API Profiles（用于为API客户端定义资源/属性级别的数据策略）。如果对此感兴趣，请创建支持案例请求Profiles支持。

有关其中一些问题的更多技术细节，请参见此处。

后续步骤

准备深入了解时，请查看以下主题：

API连接管理
API Publisher配置
API主机注意事项
Docker配置和执行注意事项
如何使用TextFormatter类

支持

有关API Publisher的支持，请使用https://support.ed-fi.org/提交支持案例和/或功能请求。

***信息

根据Apache License, Version 2.0（"许可证"）授权。

除非适用***要求或书面同意，否则根据许可证分发的软件按"原样"分发，不提供任何明示或暗示的担保或条件。请参阅许可证了解特定语言的权限和限制。

有关其他版权和许可通知，请参见NOTICES。

镜像拉取方式

您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问标签列表页面。

轩辕镜像加速拉取命令点我查看更多 ods-api-publisher 镜像标签

docker pull docker.xuanyuan.run/edfialliance/ods-api-publisher:<标签>

使用方法：

DockerHub 原生拉取命令

docker pull edfialliance/ods-api-publisher:<标签>

轩辕镜像配置手册

按平台快速找到配置文档

一键安装

一键安装 Docker

Linux Docker 一键安装

AI

用 AI 使用轩辕镜像

agents.md · AI 对话 · 提示词

Docker

登录仓库拉取

登录认证 · 私有仓库

专属域名拉取

免登录 · 高速拉取

Linux

Docker 镜像配置

Windows / Mac

Docker Desktop 配置

MacOS OrbStack

OrbStack 容器

Apple Container

macOS 原生容器

Docker Compose

Compose 项目配置

NAS

群晖

Synology 配置

飞牛

fnOS 镜像配置

绿联

绿联 NAS

威联通

QNAP 配置

极空间

极空间 NAS

Unraid

Unraid NAS

企业仓库

其他仓库

ghcr · Quay · nvcr

Harbor 镜像源

Proxy Repository 对接

Portainer 镜像源

Registries 配置

Nexus 镜像源

Docker Proxy 缓存

开发工具

Dev Containers

VS Code 开发容器

Podman

Podman 配置指南

Singularity / Apptainer

HPC 科学计算容器

Kubernetes

K8s Containerd

Kubernetes · Containerd

K3s

轻量级集群

面板 / 网络

爱快路由

爱快 4.0 · iKuai 镜像加速

宝塔面板

一键配置镜像源

需要其他帮助？请查看我们的常见问题Docker 镜像访问常见问题解答或提交工单

镜像拉取常见问题

功能

版本功能对比

功能对比 · 版本选择

支持的镜像仓库

Docker Hub · GCR · GHCR

专属域名用法

专属域名 · 开启停用 · 多仓库

新手拉取配置

docker search 限制

专属域名 · Hub 搜索

不支持 push

仅支持 pull · 不支持

拉取速度原因

带宽 · 缓存 · 冷热镜像

错误码

402 与流量用尽

402 · 流量包 · 充值

401 认证失败

401 · docker login

manifest unknown

标签错误 · 镜像不存在

410 Gone 排查

410 · Docker 升级

429 限流

免费版 · 专业版 · 企业版 · 请求频率

其他报错

DNS 超时

DNS 解析 · 网络超时

TLS 证书失败

no matching manifest（架构）

docker.sock / daemon

账号

失败是否计费

manifest · blob · 计费

申请开票（企业 / 个人）

开票 · 发票 · 工单

修改登录密码

网站 · 仓库 · 重置

注销账户

工单 · 数据 · 注销

原理

mirrors 不生效

daemon.json · 重启

去掉域名前缀

docker tag · 重命名

指定架构拉取

ARM64 · AMD64 · 多架构

latest 与「最新」

digest · 版本号 · 标签

查看全部问题→

用户好评

来自真实用户的反馈，见证轩辕镜像的优质服务

oldzhang

运维工程师

Linux服务器

"Docker访问体验非常流畅，大镜像也能快速完成下载。"