API 集成中心:功能分节
了解 API 集成中心 中“功能分节”的使用方法、操作要求和完成标准。
了解 API 集成中心 中“功能分节”的使用方法、操作要求和完成标准。 完成本页后,你应能够理解功能边界,并按步骤完成配置和验证。
开始前检查
- 已登录 DSP 平台并进入正确组织
- 已选择目标应用和当前开发版本
- 账号拥有当前功能的查看或编辑权限

功能分节
除「对接文档」外,各 Tab 使用统一的 资源表格(ResourceTable):工具栏含搜索、状态筛选、刷新、新增;表格行操作含编辑、复制、删除;API 资产 额外提供发布、下线。
API 资产
功能说明:维护平台对外暴露的 API 元数据,是后续授权、路由、策略的关联主体。

操作步骤:
- 点击 Tab 「API资产」。
- 在搜索框输入编码、名称或备注,回车或点 刷新 查询。
- 点击 新增,在弹窗中填写字段后保存。
- 对已有记录可 编辑、复制(生成新记录,不含接口ID)、删除。
- 对草稿/未发布接口:确认后点 发布;对已发布接口点 下线。

主要字段:
| 字段 | 说明 | 枚举/默认 |
|---|---|---|
| 接口编码 code | 唯一业务编码 | 必填 |
| 接口名称 name | 显示名称 | 必填 |
| 接口地址 apiUrl | 对外或逻辑地址 | 必填 |
| 请求方法 requestMethod | GET/POST/PUT/DELETE/PATCH/* | 默认 GET |
| 协议 protocol | http / https | 默认 http |
| 来源类型 sourceType | MANUAL / INTERNAL / THIRD_PARTY | 默认 MANUAL |
| 生命周期 lifecycleStatus | DRAFT / ONLINE / OFFLINE | 默认 DRAFT |
| 发布状态 publishStatus | UNPUBLISHED / PUBLISHED / OFFLINE | 默认 UNPUBLISHED |
| 发布范围 publishScope | PRIVATE / ORG / PUBLIC | 默认 PRIVATE |
预期结果:保存后提示「已保存」;发布/下线后列表状态更新,概览指标刷新。
注意事项:发布、下线、删除均有二次确认弹窗;删除不可恢复。
API 注册
功能说明:与 API 资产共用同一数据表与字段集,用于 注册视角 维护接口(界面与 API 资产一致,可按组织流程区分使用)。

操作同 4.1(无单独的发布/下线按钮时,以资产 Tab 为准)。
API 分类
功能说明:为 API 建立分类树,便于检索与权限划分。

操作步骤:新增 → 填写父分类ID、编码、名称、所属应用 → 保存。
主要字段:分类ID(只读)、父分类ID、编码、名称、所属应用 appCode、备注。
API 参数
功能说明:为指定 apiId 维护请求/响应参数定义。
主要字段:参数ID、接口ID、编码、名称、类型、默认值、备注。
调用方
功能说明:登记调用 API 的系统或应用(内部、OpenAPI、合作伙伴)。
主要字段:
| 字段 | 说明 |
|---|---|
| 调用方编码 consumerCode | 唯一标识 |
| 调用方名称 consumerName | 显示名 |
| 类型 consumerType | INTERNAL / OPENAPI / PARTNER |
| 额度 quotaLimit | 数字,0 表示不限 |
| 状态 status | ENABLED / DISABLED |
凭证
功能说明:为调用方配置 AK/SK、Token 等认证信息。
主要字段:调用方ID、认证方式(AKSK/TOKEN/DSP_TOKEN/INTERNAL)、AccessKey、Secret(仅保存时提交)、Token、过期时间、状态。
注意:Secret、Token 仅在保存时提交,列表不回显明文。
授权
功能说明:建立调用方与 API 的允许/拒绝关系及有效期。
主要字段:调用方ID、接口ID、授权类型(ALLOW/DENY)、开始/过期时间、状态。
策略
功能说明:按 API 或调用方配置限流、配额、熔断、降级。
策略类型 policyType:RATE_LIMIT、QUOTA、CIRCUIT、DEGRADE;配合时间窗口、调用次数、失败阈值、降级内容等字段。
白黑名单
功能说明:按 IP、用户、组织、应用等维度限制访问。
主要字段:名单类型(ALLOW/DENY)、目标类型(IP/USER/ORG/APP)、目标值。
路由
功能说明:将对外路径映射到上游服务,配置方法、优先级、超时。
主要字段:路由编码/名称、接口ID、路径、方法、上游ID、优先级、超时(ms)。
上游服务
功能说明:定义后端服务集群的基础地址与健康检查。
主要字段:上游编码/名称、服务编码、协议、基础地址 baseUrl、健康检查路径。
上游实例
功能说明:在上游服务下维护具体主机、端口、权重与健康状态。
调用日志
功能说明:查询历史调用记录,用于联调与故障排查。
主要列:Trace ID、接口编码、调用方ID、请求路径、状态码、耗时、是否命中限流/熔断。
监控分析
功能说明:按分钟聚合的调用量、成功率、耗时等指标。
审计记录
功能说明:记录配置变更类操作,满足合规审计。
对接文档
功能说明:查看已生成的 API 文档快照(Markdown / OpenAPI JSON),支持复制。
操作步骤:
- 切换到 「对接文档」 Tab。
- 搜索 API 编号、应用或接口ID,点击 刷新。
- 在左侧表格 点击一行,右侧显示预览。
- 在 Markdown / OpenAPI 子 Tab 间切换查看。
- 点击 复制 Markdown 将文档复制到剪贴板(提示「已复制」)。
字段与控件说明
字段名称以当前页面显示为准。不同版本或权限下,可选项可能有所差异。
| 字段名称 | 位置 | 用途 | 填写规则 | 可选值 | 影响结果 | 常见错误 |
|---|---|---|---|---|---|---|
| API资产 | Tab | 显示资产 ResourceTable | 按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举;按业务规则或页面格式要求填写。 | 会影响外部系统调用、数据同步或联调排查。 | 若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。 |
| API注册 | Tab | 注册向导/列表 | 按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举;按业务规则或页面格式要求填写。 | 会影响外部系统调用、数据同步或联调排查。 | 若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。 |
| API分类 | Tab | 分类树表 | 按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举;按业务规则或页面格式要求填写。 | 会影响外部系统调用、数据同步或联调排查。 | 若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。 |
| API参数 | Tab | 参数模板列表 | 按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举;按业务规则或页面格式要求填写。 | 会影响外部系统调用、数据同步或联调排查。 | 若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。 |
| 调用方 | Tab | 调用方列表 | 按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举;按业务规则或页面格式要求填写。 | 调用方列表 | 若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。 |
| 凭证 | Tab | AK/SK、Token 管理 | 按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举;按业务规则或页面格式要求填写。 | AK/SK、Token 管理 | 若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。 |
| 授权 | Tab | API↔调用方授权 | 按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举;按业务规则或页面格式要求填写。 | 会影响用户可访问的菜单、按钮、数据范围或审批操作。 | 若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。 |
| 策略 | Tab | 限流熔断降级 | 按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举;按业务规则或页面格式要求填写。 | 限流熔断降级 | 若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。 |
| 白黑名单 | Tab | IP/调用方黑白名单 | 按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举;按业务规则或页面格式要求填写。 | IP/调用方黑白名单 | 若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。 |
| 路由 | Tab | 路由规则 | 按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举;按业务规则或页面格式要求填写。 | 路由规则 | 若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。 |
| 上游服务 | Tab | 上游集群 | 按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举;按业务规则或页面格式要求填写。 | 上游集群 | 若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。 |
| 上游实例 | Tab | 实例节点 | 按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举;按业务规则或页面格式要求填写。 | 实例节点 | 若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。 |
| 调用日志 | Tab | 调用日志查询 | 按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举;按业务规则或页面格式要求填写。 | 调用日志查询 | 若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。 |
| 监控分析 | Tab | 指标图表 | 按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举;按业务规则或页面格式要求填写。 | 指标图表 | 若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。 |
| 审计记录 | Tab | 审计流水 | 按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举;按业务规则或页面格式要求填写。 | 审计流水 | 若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。 |
| 对接文档 | Tab | 文档导出/预览 | 按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举;按业务规则或页面格式要求填写。 | 文档导出/预览 | 若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。 |
| 刷新 | 页头 | 重新拉取概览指标卡 | 按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举;按业务规则或页面格式要求填写。 | 重新拉取概览指标卡 | 若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。 |
| 搜索框 | 工具栏 | 按编码/名称过滤列表 | 输入关键词后执行查询,支持按页面当前数据范围过滤。 | 无固定枚举;按业务规则或页面格式要求填写。 | 按编码/名称过滤列表 | 若没有结果,检查关键词、筛选条件、应用范围和当前账号数据权限。 |
| 状态筛选 | 工具栏 | 过滤草稿/已发布等 | 变更前确认影响范围,状态调整通常会影响下游可见性或执行结果。 | 以页面当前可选项为准;选项可能受权限、状态或前置配置影响。 | 会影响功能在运行环境中的可用状态,建议先完成测试验证。 | 若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。 |
| 刷新 | 工具栏 | 重新分页加载 | 按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举;按业务规则或页面格式要求填写。 | 重新分页加载 | 若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。 |
| 新增 | 工具栏 | 打开新增弹窗 | 按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举;按业务规则或页面格式要求填写。 | 打开新增弹窗 | 若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。 |
| 编辑 | 行操作 | 打开编辑弹窗 | 按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举;按业务规则或页面格式要求填写。 | 打开编辑弹窗 | 若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。 |
| 复制 | 行操作 | 复制为新记录(不含接口ID) | 按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举;按业务规则或页面格式要求填写。 | 会影响外部系统调用、数据同步或联调排查。 | 若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。 |
| 删除 | 行操作 | 确认后删除 | 按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举;按业务规则或页面格式要求填写。 | 会移除当前配置或数据,执行前确认没有被其他模块依赖。 | 若无法删除,通常是存在引用关系、权限不足或当前状态不允许删除。 |
| 发布 | 行操作 | 状态变为已发布 | 按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举;按业务规则或页面格式要求填写。 | 会影响功能在运行环境中的可用状态,建议先完成测试验证。 | 若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。 |
| 下线 | 行操作 | 状态变为下线 | 按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举;按业务规则或页面格式要求填写。 | 状态变为下线 | 若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。 |
完成标准
不要只以“按钮点击成功”作为完成依据,请至少核对以下结果。
- 显示资产 ResourceTable
- 注册向导/列表
- 分类树表
- 将内部或第三方 HTTP 接口登记为平台 API 资产并发布;
- 为合作方创建调用方、发放 AK/SK 或 Token,并配置授权与白黑名单;
