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

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资产 | 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,并配置授权与白黑名单;
常见问题
Q14:API 注册与 API 资产有何区别?
现象两个 Tab 界面相同,不知如何使用。
原因共用同一 ResourceTable 与字段集,面向不同流程角色。
处理登记用 API注册,治理与发布用 API资产;发布/下线仅在资产 Tab 提供。
