操作指南稳定能力

API 集成中心:功能分节

了解 API 集成中心 中“功能分节”的使用方法、操作要求和完成标准。

阅读本页后,你可以

了解 API 集成中心 中“功能分节”的使用方法、操作要求和完成标准。 完成本页后,你应能够理解功能边界,并按步骤完成配置和验证。

开始前检查

  • 已登录 DSP 平台并进入正确组织
  • 已选择目标应用和当前开发版本
  • 账号拥有当前功能的查看或编辑权限
功能分节界面示例
功能分节界面示例,点击可查看原图。

功能分节

除「对接文档」外,各 Tab 使用统一的 资源表格(ResourceTable):工具栏含搜索、状态筛选、刷新、新增;表格行操作含编辑、复制、删除;API 资产 额外提供发布、下线。

API 资产

功能说明:维护平台对外暴露的 API 元数据,是后续授权、路由、策略的关联主体。

图4-1 API资产列表与工具栏
图4-1 API资产列表与工具栏

操作步骤:

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

主要字段:

字段说明枚举/默认
接口编码 code唯一业务编码必填
接口名称 name显示名称必填
接口地址 apiUrl对外或逻辑地址必填
请求方法 requestMethodGET/POST/PUT/DELETE/PATCH/*默认 GET
协议 protocolhttp / https默认 http
来源类型 sourceTypeMANUAL / INTERNAL / THIRD_PARTY默认 MANUAL
生命周期 lifecycleStatusDRAFT / ONLINE / OFFLINE默认 DRAFT
发布状态 publishStatusUNPUBLISHED / PUBLISHED / OFFLINE默认 UNPUBLISHED
发布范围 publishScopePRIVATE / ORG / PUBLIC默认 PRIVATE

预期结果:保存后提示「已保存」;发布/下线后列表状态更新,概览指标刷新。

注意事项:发布、下线、删除均有二次确认弹窗;删除不可恢复。

API 注册

功能说明:与 API 资产共用同一数据表与字段集,用于 注册视角 维护接口(界面与 API 资产一致,可按组织流程区分使用)。

图4-3 API注册列表
图4-3 API注册列表

操作同 4.1(无单独的发布/下线按钮时,以资产 Tab 为准)。

API 分类

功能说明:为 API 建立分类树,便于检索与权限划分。

图4-4 API分类列表
图4-4 API分类列表

操作步骤:新增 → 填写父分类ID、编码、名称、所属应用 → 保存。

主要字段:分类ID(只读)、父分类ID、编码、名称、所属应用 appCode、备注。

API 参数

功能说明:为指定 apiId 维护请求/响应参数定义。

主要字段:参数ID、接口ID、编码、名称、类型、默认值、备注。

调用方

功能说明:登记调用 API 的系统或应用(内部、OpenAPI、合作伙伴)。

主要字段:

字段说明
调用方编码 consumerCode唯一标识
调用方名称 consumerName显示名
类型 consumerTypeINTERNAL / OPENAPI / PARTNER
额度 quotaLimit数字,0 表示不限
状态 statusENABLED / 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),支持复制。

操作步骤:

  1. 切换到 「对接文档」 Tab。
  2. 搜索 API 编号、应用或接口ID,点击 刷新。
  3. 在左侧表格 点击一行,右侧显示预览。
  4. 在 Markdown / OpenAPI 子 Tab 间切换查看。
  5. 点击 复制 Markdown 将文档复制到剪贴板(提示「已复制」)。

字段与控件说明

字段名称以当前页面显示为准。不同版本或权限下,可选项可能有所差异。

26 项
字段名称位置用途填写规则可选值影响结果常见错误
API资产Tab显示资产 ResourceTable按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。会影响外部系统调用、数据同步或联调排查。若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
API注册Tab注册向导/列表按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。会影响外部系统调用、数据同步或联调排查。若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
API分类Tab分类树表按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。会影响外部系统调用、数据同步或联调排查。若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
API参数Tab参数模板列表按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。会影响外部系统调用、数据同步或联调排查。若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
调用方Tab调用方列表按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。调用方列表若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
凭证TabAK/SK、Token 管理按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。AK/SK、Token 管理若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
授权TabAPI↔调用方授权按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。会影响用户可访问的菜单、按钮、数据范围或审批操作。若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
策略Tab限流熔断降级按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。限流熔断降级若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
白黑名单TabIP/调用方黑白名单按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。IP/调用方黑白名单若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
路由Tab路由规则按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。路由规则若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
上游服务Tab上游集群按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。上游集群若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
上游实例Tab实例节点按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。实例节点若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
调用日志Tab调用日志查询按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。调用日志查询若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
监控分析Tab指标图表按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。指标图表若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
审计记录Tab审计流水按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。审计流水若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
对接文档Tab文档导出/预览按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。文档导出/预览若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
刷新页头重新拉取概览指标卡按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。重新拉取概览指标卡若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
搜索框工具栏按编码/名称过滤列表输入关键词后执行查询,支持按页面当前数据范围过滤。无固定枚举;按业务规则或页面格式要求填写。按编码/名称过滤列表若没有结果,检查关键词、筛选条件、应用范围和当前账号数据权限。
状态筛选工具栏过滤草稿/已发布等变更前确认影响范围,状态调整通常会影响下游可见性或执行结果。以页面当前可选项为准;选项可能受权限、状态或前置配置影响。会影响功能在运行环境中的可用状态,建议先完成测试验证。若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
刷新工具栏重新分页加载按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。重新分页加载若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
新增工具栏打开新增弹窗按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。打开新增弹窗若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
编辑行操作打开编辑弹窗按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。打开编辑弹窗若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
复制行操作复制为新记录(不含接口ID)按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。会影响外部系统调用、数据同步或联调排查。若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
删除行操作确认后删除按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。会移除当前配置或数据,执行前确认没有被其他模块依赖。若无法删除,通常是存在引用关系、权限不足或当前状态不允许删除。
发布行操作状态变为已发布按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。会影响功能在运行环境中的可用状态,建议先完成测试验证。若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
下线行操作状态变为下线按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。状态变为下线若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。

完成标准

不要只以“按钮点击成功”作为完成依据,请至少核对以下结果。

  • 显示资产 ResourceTable
  • 注册向导/列表
  • 分类树表
  • 将内部或第三方 HTTP 接口登记为平台 API 资产并发布;
  • 为合作方创建调用方、发放 AK/SK 或 Token,并配置授权与白黑名单;

继续阅读