介绍

DCG REST API 总览:基础地址、版本、请求与响应约定,以及一条从认证到出报告的最短路径。

DCG REST API 让你用代码完成在控制台里能做的一切:连接数据源、触发扫描、读取逐字段分级结果、生成合规报告。

所有接口都挂在 /api/v1 前缀下,返回 JSON,使用标准 HTTP 状态码。

基础地址

text
https://<你的 DCG 实例域名>/api/v1

本地开发时,后端默认监听 8123 端口:

text
http://localhost:8123/api/v1
自托管产品

DCG 是私有化部署的产品,没有公共托管 API。下文所有示例里的主机地址,请替换成你自己实例的地址。

约定

约定说明
协议仅 HTTPS(本地开发可用 HTTP)
编码请求与响应均为 UTF-8 JSON
认证Authorization: Bearer <access_token>
时间ISO 8601,UTC(如 2026-05-20T08:00:00Z
ID资源主键为 UUID v4
分页page(从 1 起)+ size 查询参数

最短路径

从零到一份分级报告,核心是四步:

  1. 认证 —— POST /auth/login 拿到 access_token
  2. 建数据源 —— POST /datasources 登记一个数据库连接
  3. 扫描 —— POST /datasources/{id}/scan 反射 schema、采样、逐字段定级
  4. 取结果 / 出报告 —— 读分级结果,POST /reports/generate 生成合规报告
bash
# 1. 登录拿 token
curl -X POST https://your-dcg-host/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username":"admin","password":"••••••"}'

接下来从 认证 开始。