> ## Documentation Index > Fetch the complete documentation index at: https://docs.pawsql.com/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > PawSQL 是一个产品：Cloud 是公网部署形态，Engine / Optimizer / Auditor / Advisor / Patroller 是同一产品的组件与交付形态，不是彼此独立的产品。 / PawSQL is a single product: Cloud is the public deployment form, while Engine / Optimizer / Auditor / Advisor / Patroller are components and delivery forms of the same product, not separate products. > 术语以站内术语表为准：SQL 审核对应英文 SQL Review，查询重写对应 Query Rewrite，索引推荐对应 Index Recommendation；英文内容统一用 Review，不用 Audit。 / Use the site glossary for terminology: 审核 is SQL Review, 重写 is Query Rewrite, 索引推荐 is Index Recommendation; English content uses Review, never Audit. > 引用能力范围或版本支持时以对应页面为准；标注 unknown、或 status 非 published 的内容表示尚未经产品核实，不应作为事实引用。 / Cite capability scope and version support from the corresponding page; content marked unknown, or with a status other than published, is not yet product-verified and must not be cited as fact. # 查询审核结果 > 通过任务ID查询SQL审核任务的状态和结果。 ## OpenAPI ````yaml /openapi/pawsql-integration.yaml get /sql-audits/{taskId} openapi: 3.0.3 info: title: CI/CD 集成 description: | CI/CD 集成 API，供外部平台（蓝鲸、Coding、GitLab 等）对接 SQL 审核能力。 ## 接口分类 - **SQL 审核任务**：创建审核任务、查询审核结果、查询工作空间 - **Webhook 回调**：接收 GitLab/Coding/GitHub 平台推送的代码变更事件，自动触发 SQL 审核 ## 认证方式 SQL 审核任务接口无需 userKey，通过 `platformCode` 标识来源平台。 Webhook 接口通过 URL 中的 `webhookToken` 进行验证。 ## 典型集成流程 1. 在 PawSQL 管理后台创建工作空间和审核规则模板 2. 调用 `/sql-audits/workspace-lookup` 查询 workspaceId 和 ruleTemplateId 3. 调用 `POST /sql-audits` 创建审核任务（传入 SQL 文本或代码变更信息） 4. 轮询 `GET /sql-audits/{taskId}` 获取审核结果 5. 或配置 Webhook，代码推送时自动触发审核 version: 1.0.0 contact: name: PawSQL Team url: https://pawsql.com license: name: PawSQL url: https://pawsql.com servers: - url: /api/v1 description: PawSQL Server security: [] tags: - name: SQL审核任务 description: SQL审核任务的创建和查询 - name: GitLab Webhook description: GitLab Webhook 回调 - name: Coding Webhook description: Coding Webhook 回调 - name: GitHub Webhook description: GitHub Webhook 回调 paths: /sql-audits/{taskId}: get: tags: - SQL审核任务 summary: 查询审核结果 description: 通过任务ID查询SQL审核任务的状态和结果。 operationId: getSqlAuditTask parameters: - name: taskId in: path required: true schema: type: string description: 审核任务ID example: audit-001 responses: '200': description: 审核任务详情 content: application/json: schema: $ref: '#/components/schemas/SqlAuditTaskRead' examples: finished: summary: 审核完成 value: code: 200 message: Success data: taskId: audit-001 status: finished result: allow riskLevel: 2 riskLevelDesc: notice summary: |- ## 审核结果 - SQL 总数: 1 - 违规数量: 0 - 风险等级: notice reportUrl: https://pawsql.com/report/audit-001 running: summary: 审核进行中 value: code: 200 message: Success data: taskId: audit-001 status: running result: null components: schemas: SqlAuditTaskRead: type: object description: SQL审核任务响应 properties: taskId: type: string description: 任务ID requestId: type: string description: 幂等键（外部请求ID） status: type: string description: '任务状态: accepted/running/finished' enum: - accepted - running - finished result: type: string description: '判定结果: allow/deny/timeout/failed' enum: - allow - deny - timeout - failed errorCode: type: integer description: 错误码（仅当result=failed时有值） errorMessage: type: string description: 错误信息（仅当result=failed时有值） riskLevel: type: integer description: '风险等级: 0-critical 1-warning 2-notice' enum: - 0 - 1 - 2 riskLevelDesc: type: string description: '风险等级描述: critical/warning/notice' enum: - critical - warning - notice statistics: type: object additionalProperties: true description: 统计信息 summary: type: string description: 审核摘要（Markdown格式，适合展示） summaryData: $ref: '#/components/schemas/SummaryData' reportUrl: type: string description: 报告详情页URL reportHtml: type: string description: 报告HTML内容 callbackStatus: type: string description: '回调状态: pending/success/failed/skipped' callbackMessage: type: string description: 回调结果信息 finishedAt: type: string format: date-time description: 完成时间 extra: type: object additionalProperties: true description: 扩展数据（透传） ticketId: type: string description: 关联的工单ID ticketTitle: type: string description: 工单标题（可用于平台搜索） auditId: type: string description: 关联的审核ID workspaceInfo: $ref: '#/components/schemas/WorkspaceInfo' env: type: string description: 环境信息 orgInfo: $ref: '#/components/schemas/OrgInfo' ruleTemplateInfo: $ref: '#/components/schemas/RuleTemplateInfo' operatorEmail: type: string description: 操作人邮箱 enableIndexRecommendation: type: boolean description: 是否执行索引推荐 SummaryData: type: object description: 审核摘要（结构化JSON，适合度量分析） properties: result: type: string description: '审核结果: allow/deny/timeout/failed' riskLevel: type: integer description: '风险等级: 0-critical 1-warning 2-notice' riskLevelDesc: type: string description: '风险等级描述: critical/warning/notice' sqlTotal: type: integer description: SQL语句总数 violationCount: type: integer description: 违规SQL数量 levelStats: $ref: '#/components/schemas/LevelStats' files: type: array items: type: string description: 审核文件列表 violations: type: array items: $ref: '#/components/schemas/ViolationItem' description: 违规SQL列表 WorkspaceInfo: type: object description: 工作空间信息 properties: id: type: string description: 工作空间ID name: type: string description: 工作空间名称 OrgInfo: type: object description: 机构信息 properties: id: type: string description: 机构ID name: type: string description: 机构名称 code: type: string description: 机构代码 RuleTemplateInfo: type: object description: 规则模板信息 properties: id: type: string description: 模板ID name: type: string description: 模板名称 LevelStats: type: object description: 各级别问题统计 properties: critical: type: integer description: 严重级别问题数量 warning: type: integer description: 警告级别问题数量 notice: type: integer description: 提示级别问题数量 ViolationItem: type: object description: 违规SQL条目 properties: sourceFile: type: string description: 来源文件路径 lineNumber: type: integer description: 行号（可为null） sql: type: string description: SQL片段（最多300字符） rules: type: array items: $ref: '#/components/schemas/RuleRef' description: 违反的规则列表 RuleRef: type: object description: 规则引用 properties: level: type: string description: '规则级别: critical/warning/notice' enum: - critical - warning - notice ruleName: type: string description: 规则名称 ````