@Deprecated @Summary 审批通过 @Description approve workflow @Tags workflow @Id approveWorkflowV1 @Security ApiKeyAuth @Param workflow_name path string true "workflow name" @Param workflow_step_id path string true "workflow step id" @Param project_name path string true "project name" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/workflows/{workflow_name}/steps/{workflow_step_id}/approve [post].

@Summary 扫描任务触发sql审核 @Description audit plan trigger sql audit @Id auditPlanTriggerSqlAuditV1 @Tags instance_audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param instance_audit_plan_id path string true "instance audit plan id" @Param audit_plan_id path string true "audit plan id" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/instance_audit_plans/{instance_audit_plan_id}/audit_plans/{audit_plan_id}/audit [post].

AuditTaskGroupV1 @Summary 审核任务组 @Description audit task group.

BatchCancelWorkflows batch cancel workflows.

BatchCheckInstanceConnections test instance db connection @Summary 批量测试实例连通性（实例提交后） @Description batch test instance db connections @Id batchCheckInstanceIsConnectableByName @Tags instance @Security ApiKeyAuth @Param project_name path string true "project name" @Param instances body v1.BatchCheckInstanceConnectionsReqV1 true "instances" @Success 200 {object} v1.BatchGetInstanceConnectionsResV1 @router /v1/projects/{project_name}/instances/connections [post].

BatchCompleteWorkflows complete workflows.

BatchUpdateSqlManage batch update sql manage @Summary 批量更新SQL管控 @Description batch update sql manage @Tags SqlManage @Id BatchUpdateSqlManage @Security ApiKeyAuth @Param project_name path string true "project name" @Param BatchUpdateSqlManageReq body BatchUpdateSqlManageReq true "batch update sql manage request" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/sql_manages/batch [PATCH].

@Deprecated @Summary 审批关闭（中止） @Description cancel workflow @Tags workflow @Id cancelWorkflowV1 @Security ApiKeyAuth @Param project_name path string true "project name" @Param workflow_name path string true "workflow name" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/workflows/{workflow_name}/cancel [post].

TODO 使用DMS的权限校验.

CheckInstanceIsConnectableByName test instance db connection @Summary 实例连通性测试（实例提交后） @Description test instance db connection @Id checkInstanceIsConnectableByNameV1 @Tags instance @Security ApiKeyAuth @Param project_name path string true "project name" @Param instance_name path string true "instance name" @Success 200 {object} v1.GetInstanceConnectableResV1 @router /v1/projects/{project_name}/instances/{instance_name}/connection [get].

CheckLicense parse and check sqle license @Summary 解析和校验 sqle license @Description parse and check sqle license @Id checkSQLELicenseV1 @Tags configuration @Accept mpfd @Security ApiKeyAuth @Param license_file formData file true "SQLE license file" @Success 200 {object} v1.CheckLicenseResV1 @router /v1/configurations/license/check [post].

CloneProjectRuleTemplate @Summary 克隆项目规则模板 @Description clone a rule template in project @Id cloneProjectRuleTemplateV1 @Tags rule_template @Security ApiKeyAuth @Accept json @Param project_name path string true "project name" @Param rule_template_name path string true "rule template name" @Param req body v1.CloneProjectRuleTemplateReqV1 true "clone rule template request" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/rule_templates/{rule_template_name}/clone [post].

@Summary 克隆全局规则模板 @Description clone a rule template @Id CloneRuleTemplateV1 @Tags rule_template @Security ApiKeyAuth @Accept json @Param rule_template_name path string true "rule template name" @Param req body v1.CloneRuleTemplateReqV1 true "clone rule template request" @Success 200 {object} controller.BaseRes @router /v1/rule_templates/{rule_template_name}/clone [post].

@Summary 创建Sql扫描任务并提交审核 @Description create and audit a task, you can upload sql content in three ways, any one can be used, but only one is effective.

@Summary 添加扫描任务 @Description create audit plan @Id createAuditPlanV1 @Tags audit_plan @Security ApiKeyAuth @Accept json @Param project_name path string true "project name" @Param audit_plan body v1.CreateAuditPlanReqV1 true "create audit plan" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/audit_plans [post].

CreateAuditTasksGroupV1 @Summary 创建审核任务组 @Description create tasks group.

@Summary 添加SQL白名单 @Description create a sql whitelist @Accept json @Id createAuditWhitelistV1 @Tags audit_whitelist @Security ApiKeyAuth @Param project_name path string true "project name" @Param instance body v1.CreateAuditWhitelistReqV1 true "add sql whitelist req" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/audit_whitelist [post].

CreateBlacklist @Summary 添加黑名单 @Description create a blacklist @Accept json @Id createBlacklistV1 @Tags blacklist @Security ApiKeyAuth @Param project_name path string true "project name" @Param instance body v1.CreateBlacklistReqV1 true "add blacklist req" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/blacklist [post].

@Summary 添加自定义规则 @Description create custom rule @Id createCustomRuleV1 @Tags rule_template @Security ApiKeyAuth @Param instance body v1.CreateCustomRuleReqV1 true "add custom rule" @Success 200 {object} controller.BaseRes @router /v1/custom_rules [post].

@Summary 添加实例扫描任务 @Description create instance audit plan @Id createInstanceAuditPlanV1 @Tags instance_audit_plan @Security ApiKeyAuth @Accept json @Param project_name path string true "project name" @Param instannce_audit_plan body v1.CreateInstanceAuditPlanReqV1 true "create instance audit plan" @Success 200 {object} v1.CreatInstanceAuditPlanResV1 @router /v1/projects/{project_name}/instance_audit_plans [post].

@Summary 创建流水线 @Description create pipeline @Id createPipelineV1 @Tags pipeline @Security ApiKeyAuth @Accept json @Param project_name path string true "project name" @Param pipeline body v1.CreatePipelineReqV1 true "create pipeline" @Success 200 {object} v1.CreatePipelineResV1 @router /v1/projects/{project_name}/pipelines [post].

CreateProjectRuleTemplate @Summary 添加项目规则模板 @Description create a rule template in project @Id createProjectRuleTemplateV1 @Tags rule_template @Security ApiKeyAuth @Accept json @Param project_name path string true "project name" @Param req body v1.CreateProjectRuleTemplateReqV1 true "add rule template request" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/rule_templates [post].

@Summary 添加全局规则模板 @Description create a global rule template @Id createRuleTemplateV1 @Tags rule_template @Security ApiKeyAuth @Accept json @Param req body v1.CreateRuleTemplateReqV1 true "add rule template request" @Success 200 {object} controller.BaseRes @router /v1/rule_templates [post].

CreateSQLAuditRecord @Summary SQL审核 @Id CreateSQLAuditRecordV1 @Description SQL audit @Description 1.

CreateWorkflowV1 @Deprecated @Summary 创建工单 @Description create workflow @Accept json @Produce json @Tags workflow @Id createWorkflowV1 @Security ApiKeyAuth @Param instance body v1.CreateWorkflowReqV1 true "create workflow request" @Param project_name path string true "project name" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/workflows [post].

@Summary 获取 dashboard 信息 @Description get dashboard info @Id getDashboardV1 @Tags dashboard @Security ApiKeyAuth @Param filter_project_name query string false "filter project name" @Produce json @Success 200 {object} v1.GetDashboardResV1 @router /v1/dashboard [get].

@Summary 删除扫描任务 @Description delete audit plan @Id deleteAuditPlanV1 @Tags audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param audit_plan_name path string true "audit plan name" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/audit_plans/{audit_plan_name}/ [delete].

@Summary 删除扫描任务 @Description delete audit plan by type @Id deleteAuditPlanByTypeV1 @Tags instance_audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param instance_audit_plan_id path string true "instance audit plan id" @Param audit_plan_id path string true "audit plan id" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/instance_audit_plans/{instance_audit_plan_id}/audit_plans/{audit_plan_id}/ [delete].

@Summary 删除SQL白名单信息 @Description remove sql white @Id deleteAuditWhitelistByIdV1 @Tags audit_whitelist @Security ApiKeyAuth @Param project_name path string true "project name" @Param audit_whitelist_id path string true "audit whitelist id" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/audit_whitelist/{audit_whitelist_id}/ [delete].

DeleteBlacklist @Description delete a blacklist @Id deleteBlackList @Tags blacklist @Security ApiKeyAuth @Param project_name path string true "project name" @Param blacklist_id path string true "blacklist id" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/blacklist/{blacklist_id}/ [delete].

@Summary 删除自定义规则 @Description delete custom rule @Id deleteCustomRuleV1 @Tags rule_template @Security ApiKeyAuth @Param rule_id path string true "rule id" @Success 200 {object} controller.BaseRes @router /v1/custom_rules/{rule_id} [delete].

@Summary 删除实例扫描任务 @Description delete instance audit plan @Id deleteInstanceAuditPlanV1 @Tags instance_audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param instance_audit_plan_id path string true "instance audit plan id" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/instance_audit_plans/{instance_audit_plan_id}/ [delete].

@Summary 删除流水线 @Description delete pipeline @Id deletePipelineV1 @Tags pipeline @Security ApiKeyAuth @Param project_name path string true "project name" @Param pipeline_id path string true "pipeline id" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/pipelines/{pipeline_id}/ [delete].

DeleteProjectRuleTemplate @Summary 删除项目规则模板 @Description delete rule template in project @Id deleteProjectRuleTemplateV1 @Tags rule_template @Security ApiKeyAuth @Param project_name path string true "project name" @Param rule_template_name path string true "rule template name" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/rule_templates/{rule_template_name}/ [delete].

@Summary 删除全局规则模板 @Description delete global rule template @Id deleteRuleTemplateV1 @Tags rule_template @Security ApiKeyAuth @Param rule_template_name path string true "rule template name" @Success 200 {object} controller.BaseRes @router /v1/rule_templates/{rule_template_name}/ [delete].

@Deprecated @Summary 直接审核SQL @Description Direct audit sql @Id directAuditV1 @Tags sql_audit @Security ApiKeyAuth @Param req body v1.DirectAuditReqV1 true "sqls that should be audited" @Success 200 {object} v1.DirectAuditResV1 @router /v1/sql_audit [post].

@Summary 直接从文件内容提取SQL并审核，SQL文件暂时只支持一次解析一个文件 @Description Direct audit sql from SQL files and MyBatis files @Id directAuditFilesV1 @Tags sql_audit @Security ApiKeyAuth @Param req body v1.DirectAuditFileReqV1 true "files that should be audited" @Success 200 {object} v1.DirectAuditResV1 @router /v1/audit_files [post].

DirectGetSQLAnalysis @Summary 直接获取SQL分析结果 @Description Direct get sql analysis result @Id directGetSQLAnalysisV1 @Tags sql_analysis @Param project_name query string true "project name" @Param instance_name query string true "instance name" @Param schema_name query string false "schema name" @Param sql query string false "sql" @Security ApiKeyAuth @Success 200 {object} v1.DirectGetSQLAnalysisResV1 @router /v1/sql_analysis [get].

@Summary 获取指定审核任务的原始文件 @Description get SQL origin file of the audit task @Tags task @Id DownloadAuditFile @Security ApiKeyAuth @Param task_id path string true "task id" @Success 200 {object} controller.BaseRes @router /v1/tasks/audits/{task_id}/origin_file [get].

@Summary 下载指定扫描任务的SQL文件 @Description download SQL file for the audit task @Tags task @Id downloadAuditTaskSQLFileV1 @Security ApiKeyAuth @Param task_id path string true "task id" @Success 200 file 1 "sql file" @router /v1/tasks/audits/{task_id}/sql_file [get].

@Summary 下载指定扫描任务的SQLs信息报告 @Description download report file of all SQLs information belong to the specified audit task @Tags task @Id downloadAuditTaskSQLReportV1 @Security ApiKeyAuth @Param task_id path string true "task id" @Param no_duplicate query boolean false "select unique (fingerprint and audit result) for task sql" @Success 200 file 1 "sql report csv file" @router /v1/tasks/audits/{task_id}/sql_report [get].

ExecuteOneTaskOnWorkflowV1 @Deprecated @Summary 工单提交单个数据源上线 @Description execute one task on workflow @Tags workflow @Id executeOneTaskOnWorkflowV1 @Security ApiKeyAuth @Param workflow_name path string true "workflow name" @Param project_name path string true "project name" @Param task_id path string true "task id" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/workflows/{workflow_name}/tasks/{task_id}/execute [post].

ExecuteTasksOnWorkflowV1 @Deprecated @Summary 多数据源批量上线 @Description execute tasks on workflow @Tags workflow @Id executeTasksOnWorkflowV1 @Security ApiKeyAuth @Param workflow_name path string true "workflow name" @Param project_name path string true "project name" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/workflows/{workflow_name}/tasks/execute [post].

GetAuditPlanAnalysisData get SQL explain and related table metadata for analysis @Summary 以csv的形式导出扫描报告 @Description export audit plan report as csv @Id exportAuditPlanReportV1 @Tags audit_plan @Param project_name path string true "project name" @Param audit_plan_name path string true "audit plan name" @Param audit_plan_report_id path string true "audit plan report id" @Security ApiKeyAuth @Success 200 {file} file "get export audit plan report" @router /v1/projects/{project_name}/audit_plans/{audit_plan_name}/reports/{audit_plan_report_id}/export [get].

ExportProjectRuleTemplateFile @Summary 导出项目规则模板 @Description export rule template in a project @Id exportProjectRuleTemplateV1 @Tags rule_template @Param project_name path string true "project name" @Param rule_template_name path string true "rule template name" @Security ApiKeyAuth @Success 200 file 1 "sqle rule template file" @router /v1/projects/{project_name}/rule_templates/{rule_template_name}/export [get].

ExportRuleTemplateFile @Summary 导出全局规则模板 @Description export rule template @Id exportRuleTemplateV1 @Tags rule_template @Param rule_template_name path string true "rule template name" @Security ApiKeyAuth @Success 200 file 1 "sqle rule template file" @router /v1/rule_templates/{rule_template_name}/export [get].

ExportSqlManagesV1 @Summary 导出SQL管控 @Description export sql manage @Id exportSqlManageV1 @Tags SqlManage @Security ApiKeyAuth @Param project_name path string true "project name" @Param fuzzy_search_sql_fingerprint query string false "fuzzy search sql fingerprint" @Param filter_assignee query string false "assignee" @Param filter_business query string false "business" @Param filter_priority query string false "priority" Enums(high,low) @Param filter_instance_id query string false "instance id" @Param filter_source query string false "source" Enums(audit_plan,sql_audit_record) @Param filter_audit_level query string false "audit level" Enums(normal,notice,warn,error) @Param filter_last_audit_start_time_from query string false "last audit start time from" @Param filter_last_audit_start_time_to query string false "last audit start time to" @Param filter_status query string false "status" Enums(unhandled,solved,ignored,manual_audited) @Param filter_db_type query string false "db type" @Param filter_rule_name query string false "rule name" @Param fuzzy_search_endpoint query string false "fuzzy search endpoint" @Param fuzzy_search_schema_name query string false "fuzzy search schema name" @Param sort_field query string false "sort field" Enums(first_appear_timestamp,last_receive_timestamp,fp_count) @Param sort_order query string false "sort order" Enums(asc,desc) @Success 200 {file} file "export sql manage" @Router /v1/projects/{project_name}/sql_manages/exports [get].

ExportWorkflowV1 @Summary 导出工单 @Description export workflow @Id exportWorkflowV1 @Tags workflow @Security ApiKeyAuth @Param filter_subject query string false "filter subject" @Param fuzzy_search_workflow_desc query string false "fuzzy search by workflow description" @Param filter_create_time_from query string false "filter create time from" @Param filter_create_time_to query string false "filter create time to" @Param filter_task_execute_start_time_from query string false "filter_task_execute_start_time_from" @Param filter_task_execute_start_time_to query string false "filter_task_execute_start_time_to" @Param filter_create_user_id query string false "filter create user id" @Param filter_status query string false "filter workflow status" Enums(wait_for_audit,wait_for_execution,rejected,executing,canceled,exec_failed,finished) @Param filter_current_step_assignee_user_id query string false "filter current step assignee user id" @Param filter_task_instance_id query string false "filter instance id" @Param project_name path string true "project name" @Param fuzzy_keyword query string false "fuzzy matching subject/workflow_id/desc" @Success 200 {file} file "export workflow" @Router /v1/projects/{project_name}/workflows/exports [get].

todo: 后续该接口会废弃 @Deprecated @Summary 全量同步SQL到扫描任务 @Description full sync audit plan SQLs @Id fullSyncAuditPlanSQLsV1 @Tags audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param audit_plan_name path string true "audit plan name" @Param sqls body v1.FullSyncAuditPlanSQLsReqV1 true "full sync audit plan SQLs request" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/audit_plans/{audit_plan_name}/sqls/full [post].

@Summary 获取指定扫描任务 @Description get audit plan @Id getAuditPlanV1 @Tags audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param audit_plan_name path string true "audit plan name" @Success 200 {object} v1.GetAuditPlanResV1 @router /v1/projects/{project_name}/audit_plans/{audit_plan_name}/ [get].

GetAuditPlanAnalysisData get SQL explain and related table metadata for analysis @Summary 获取task相关的SQL执行计划和表元数据 @Description get SQL explain and related table metadata for analysis @Id getTaskAnalysisData @Tags audit_plan @Param project_name path string true "project name" @Param audit_plan_name path string true "audit plan name" @Param audit_plan_report_id path string true "audit plan report id" @Param number path string true "sql number" @Security ApiKeyAuth @Success 200 {object} v1.GetAuditPlanAnalysisDataResV1 @router /v1/projects/{project_name}/audit_plans/{audit_plan_name}/reports/{audit_plan_report_id}/sqls/{number}/analysis [get].

@Summary 获取扫描任务元信息 @Description get audit plan metas @Id getAuditPlanMetasV1 @Tags audit_plan @Security ApiKeyAuth @Param filter_instance_type query string false "filter instance type" @Param filter_instance_id query string false "filter instance id" @Success 200 {object} v1.GetAuditPlanMetasResV1 @router /v1/audit_plan_metas [get].

@Summary 获取扫描任务消息推送设置 @Description get audit plan notify config @Id getAuditPlanNotifyConfigV1 @Tags audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param audit_plan_name path string true "audit plan name" @Success 200 {object} v1.GetAuditPlanNotifyConfigResV1 @router /v1/projects/{project_name}/audit_plans/{audit_plan_name}/notify_config [get].

@Summary 获取指定扫描任务的SQL扫描记录统计信息 @Description get audit plan report @Id getAuditPlanReportV1 @Tags audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param audit_plan_name path string true "audit plan name" @Param audit_plan_report_id path string true "audit plan report id" @Success 200 {object} v1.GetAuditPlanReportResV1 @router /v1/projects/{project_name}/audit_plans/{audit_plan_name}/reports/{audit_plan_report_id}/ [get].

@Summary 获取指定扫描任务的报告列表 @Description get audit plan report list @Id getAuditPlanReportsV1 @Tags audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param audit_plan_name path string true "audit plan name" @Param page_index query uint32 true "page index" @Param page_size query uint32 true "size of per page" @Success 200 {object} v1.GetAuditPlanReportsResV1 @router /v1/projects/{project_name}/audit_plans/{audit_plan_name}/reports [get].

GetAuditPlanReportSQLsV1 is to fix the irregular uri used by GetAuditPlanReportSQLs issue: https://github.com/actiontech/sqle/issues/429 @Summary 获取指定扫描任务的SQL扫描详情 @Description get audit plan report SQLs @Id getAuditPlanReportsSQLsV1 @Tags audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param audit_plan_name path string true "audit plan name" @Param audit_plan_report_id path string true "audit plan report id" @Param page_index query uint32 true "page index" @Param page_size query uint32 true "size of per page" @Success 200 {object} v1.GetAuditPlanReportSQLsResV1 @router /v1/projects/{project_name}/audit_plans/{audit_plan_name}/reports/{audit_plan_report_id}/sqls [get].

GetAuditPlans @Summary 获取扫描任务信息列表 @Description get audit plan info list @Id getAuditPlansV1 @Tags audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param filter_audit_plan_db_type query string false "filter audit plan db type" @Param fuzzy_search_audit_plan_name query string false "fuzzy search audit plan name" @Param filter_audit_plan_type query string false "filter audit plan type" @Param filter_audit_plan_instance_name query string false "filter audit plan instance name" @Param page_index query uint32 true "page index" @Param page_size query uint32 true "size of per page" @Success 200 {object} v1.GetAuditPlansResV1 @router /v1/projects/{project_name}/audit_plans [get].

GetAuditPlanSqlAnalysisData get SQL explain and related table metadata for analysis @Summary 获取扫描任务相关的SQL执行计划和表元数据 @Description get SQL explain and related table metadata for analysis @Id getAuditPlanSqlAnalysisDataV1 @Tags instance_audit_plan @Param project_name path string true "project name" @Param instance_audit_plan_id path string true "instance audit plan id" @Param id path string true "audit plan sql id" @Security ApiKeyAuth @Success 200 {object} v1.GetSqlManageSqlAnalysisResp @router /v1/projects/{project_name}/instance_audit_plans/{instance_audit_plan_id}/sqls/{id}/analysis [get].

@Summary 获取指定扫描任务的SQLs信息(不包括扫描结果) @Description get audit plan SQLs @Id getAuditPlanSQLsV1 @Tags audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param audit_plan_name path string true "audit plan name" @Param page_index query uint32 true "page index" @Param page_size query uint32 true "size of per page" @Success 200 {object} v1.GetAuditPlanSQLsResV1 @router /v1/projects/{project_name}/audit_plans/{audit_plan_name}/sqls [get].

GetAuditPlanTypes @Summary 获取扫描任务类型 @Description get audit plan types @Id getAuditPlanTypesV1 @Tags audit_plan @Security ApiKeyAuth @Success 200 {object} v1.GetAuditPlanTypesResV1 @router /v1/audit_plan_types [get].

@Summary 获取指定扫描任务的SQL内容 @Description get SQL content for the audit task @Tags task @Id getAuditTaskSQLContentV1 @Security ApiKeyAuth @Param task_id path string true "task id" @Success 200 {object} v1.GetAuditTaskSQLContentResV1 @router /v1/tasks/audits/{task_id}/sql_content [get].

GetBlacklist @Summary 获取黑名单列表 @Description get blacklist @Id getBlacklistV1 @Tags blacklist @Security ApiKeyAuth @Param project_name path string true "project name" @Param filter_type query string false "filter type" Enums(sql,fp_sql,ip,cidr,host,instance) @Param fuzzy_search_content query string false "fuzzy search content" @Param page_index query string true "page index" @Param page_size query string true "page size" @Success 200 {object} v1.GetBlacklistResV1 @router /v1/projects/{project_name}/blacklist [get].

根据用户权限获取能访问/操作的实例列表.

GetCompanyNotice @Summary 获取企业公告 @Description get company notice info @Id getCompanyNotice @Tags companyNotice @Security ApiKeyAuth @Success 200 {object} v1.GetCompanyNoticeResp @Router /v1/company_notice [get].

@Summary 获取自定义规则 @Description get custom rule by rule_id @Id getCustomRuleV1 @Tags rule_template @Security ApiKeyAuth @Param rule_id path string true "rule id" @Success 200 {object} v1.GetCustomRuleResV1 @router /v1/custom_rules/{rule_id} [get].

GetCustomRuleKnowledge @Summary 查看自定义规则知识库 @Description get custom rule knowledge @Id getCustomRuleKnowledgeV1 @Tags rule_template @Security ApiKeyAuth @Param rule_name path string true "rule name" @Param db_type path string true "db type of rule" @Success 200 {object} v1.GetRuleKnowledgeResV1 @router /v1/rule_knowledge/db_types/{db_type}/custom_rules/{rule_name}/ [get].

@Summary 自定义规则列表 @Description get all custom rule template @Id getCustomRulesV1 @Tags rule_template @Security ApiKeyAuth @Param filter_db_type query string false "filter db type" @Param filter_desc query string false "filter desc" @Success 200 {object} v1.GetCustomRulesResV1 @router /v1/custom_rules [get].

GetDBPerformanceImproveOverview @Summary 获取实例性能提升概览 @Description get db optimization performance improvements @Tags sql_optimization @Id getDBPerformanceImproveOverview @Security ApiKeyAuth @Param project_name path string true "project name" @Success 200 {object} v1.GetDBPerformanceImproveOverviewResp @router /v1/projects/{project_name}/statistic/optimization_performance_improve_overview [get].

GetDingTalkConfigurationV1 @Summary 获取 dingTalk 配置 @Description get dingTalk configuration @Id getDingTalkConfigurationV1 @Tags configuration @Security ApiKeyAuth @Success 200 {object} v1.GetDingTalkConfigurationResV1 @router /v1/configurations/ding_talk [get].

GetDrivers get support Driver list.

GetExportOperationRecordListV1 @Summary 导出操作记录列表 @Description Export operation record list @Id getExportOperationRecordListV1 @Tags OperationRecord @Security ApiKeyAuth @Param filter_operate_time_from query string false "filter_operate_time_from" @Param filter_operate_time_to query string false "filter_operate_time_to" @Param filter_operate_project_name query string false "filter_operate_project_name" @Param fuzzy_search_operate_user_name query string false "fuzzy_search_operate_user_name" @Param filter_operate_type_name query string false "filter_operate_type_name" @Param filter_operate_action query string false "filter_operate_action" @Success 200 {file} file "get export operation record list" @Router /v1/operation_records/exports [get].

GetFeishuAuditConfigurationV1 @Summary 获取飞书审核配置 @Description get feishu audit configuration @Id getFeishuAuditConfigurationV1 @Tags configuration @Security ApiKeyAuth @Success 200 {object} v1.GetFeishuAuditConfigurationResV1 @router /v1/configurations/feishu_audit [get].

GetGlobalWorkflowsV1 @Summary 获取全局工单列表 @Description get global workflow list @Tags workflow @Id getGlobalWorkflowsV1 @Security ApiKeyAuth @Param filter_subject query string false "filter subject" @Param filter_create_time_from query string false "filter create time from" @Param filter_create_time_to query string false "filter create time to" @Param filter_task_execute_start_time_from query string false "filter_task_execute_start_time_from" @Param filter_task_execute_start_time_to query string false "filter_task_execute_start_time_to" @Param filter_create_user_id query string false "filter create user id" @Param filter_status query string false "filter workflow status" Enums(wait_for_audit,wait_for_execution,rejected,executing,canceled,exec_failed,finished) @Param filter_current_step_assignee_user_id query string false "filter current step assignee user id" @Param filter_task_instance_id query string false "filter instance id" @Param page_index query uint32 true "page index" @Param page_size query uint32 true "size of per page" @Success 200 {object} v1.GetWorkflowsResV1 @router /v1/workflows [get].

@Summary 获取实例扫描任务详情 @Description get instance audit plan detail @Id getInstanceAuditPlanDetailV1 @Tags instance_audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param instance_audit_plan_id path string true "instance audit plan id" @Success 200 {object} v1.GetInstanceAuditPlanDetailResV1 @router /v1/projects/{project_name}/instance_audit_plans/{instance_audit_plan_id} [get].

@Summary 获取实例扫描任务概览 @Description get audit plan overview @Id getInstanceAuditPlanOverviewV1 @Tags instance_audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param instance_audit_plan_id path string true "instance audit plan id" @Success 200 {object} v1.GetInstanceAuditPlanOverviewResV1 @router /v1/projects/{project_name}/instance_audit_plans/{instance_audit_plan_id}/audit_plans [get].

GetInstanceAuditPlans @Summary 获取实例扫描任务列表 @Description get instance audit plan info list @Id getInstanceAuditPlansV1 @Tags instance_audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param filter_by_business query string false "filter by business" @Param filter_by_db_type query string false "filter by db type" @Param filter_by_instance_id query string false "filter by instance id" @Param filter_by_audit_plan_type query string false "filter instance audit plan type" @Param filter_by_active_status query string false "filter instance audit plan active status" @Param fuzzy_search query string false "fuzzy search" @Param page_index query uint32 true "page index" @Param page_size query uint32 true "size of per page" @Success 200 {object} v1.GetInstanceAuditPlansResV1 @router /v1/projects/{project_name}/instance_audit_plans [get].

@Summary 获取指定扫描任务的SQL列表 @Description get audit plan SQLs @Id getInstanceAuditPlanSQLDataV1 @Tags instance_audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param instance_audit_plan_id path string true "instance audit plan id" @Param audit_plan_id path string true "audit plan id" @param audit_plan_sql_request body v1.GetAuditPlanSQLDataReqV1 true "audit plan sql data request" @Success 200 {object} v1.GetAuditPlanSQLDataResV1 @router /v1/projects/{project_name}/instance_audit_plans/{instance_audit_plan_id}/audit_plans/{audit_plan_id}/sql_data [post].

@Summary 导出指定扫描任务的 SQL CSV 列表 @Description export audit plan SQL report as CSV @Id getInstanceAuditPlanSQLExportV1 @Tags instance_audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param instance_audit_plan_id path string true "instance audit plan id" @Param audit_plan_id path string true "audit plan id" @param audit_plan_sql_request body v1.GetAuditPlanSQLExportReqV1 true "audit plan sql export request" @Success 200 {file} file "export audit plan sql report" @router /v1/projects/{project_name}/instance_audit_plans/{instance_audit_plan_id}/audit_plans/{audit_plan_id}/sql_export [post].

@Summary 获取指定扫描任务的SQL列表元信息 @Description get audit plan SQL meta @Id getInstanceAuditPlanSQLMetaV1 @Tags instance_audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param instance_audit_plan_id path string true "instance audit plan id" @Param audit_plan_id path string true "audit plan id" @Success 200 {object} v1.GetAuditPlanSQLMetaResV1 @router /v1/projects/{project_name}/instance_audit_plans/{instance_audit_plan_id}/audit_plans/{audit_plan_id}/sql_meta [get].

@Summary 获取指定扫描任务的SQLs信息 @Description get audit plan SQLs @Id getInstanceAuditPlanSQLsV1 @Tags instance_audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param instance_audit_plan_id path string true "instance audit plan id" @Param audit_plan_id path string true "audit plan id" @Param page_index query uint32 true "page index" @Param page_size query uint32 true "size of per page" @Success 200 {object} v1.GetAuditPlanSQLsResV1 @router /v1/projects/{project_name}/instance_audit_plans/{instance_audit_plan_id}/audit_plans/{audit_plan_id}/sqls [get].

GetInstanceHealthV1 @Summary 获取各类型数据源的健康情况 @Description get instance health @Tags statistic @Id GetInstanceHealthV1 @Security ApiKeyAuth @Param project_name path string true "project name" @Success 200 {object} v1.GetInstanceHealthResV1 @router /v1/projects/{project_name}/statistic/instance_health [get].

GetInstanceRules get instance all rule @Summary 获取实例应用的规则列表 @Description get instance all rule @Id getInstanceRuleListV1 @Tags instance @Security ApiKeyAuth @Param project_name path string true "project name" @Param instance_name path string true "instance name" @Success 200 {object} v1.GetRulesResV1 @router /v1/projects/{project_name}/instances/{instance_name}/rules [get].

GetInstanceSchemas get instance schema list @Summary 实例 Schema 列表 @Description instance schema list @Id getInstanceSchemasV1 @Tags instance @Security ApiKeyAuth @Param project_name path string true "project name" @Param instance_name path string true "instance name" @Success 200 {object} v1.GetInstanceSchemaResV1 @router /v1/projects/{project_name}/instances/{instance_name}/schemas [get].

GetInstancesTypePercentV1 @Summary 获取数据源类型百分比 @Description get database instances' types percent @Tags statistic @Id getInstancesTypePercentV1 @Security ApiKeyAuth @Success 200 {object} v1.GetInstancesTypePercentResV1 @router /v1/statistic/instances/type_percent [get].

GetInstanceTips get instance tip list @Summary 获取实例提示列表 @Description get instance tip list @Tags instance @Id getInstanceTipListV1 @Security ApiKeyAuth @Param project_name path string true "project name" @Param filter_db_type query string false "filter db type" @Param filter_by_business query string false "filter by business" @Param filter_workflow_template_id query string false "filter workflow template id" @Param functional_module query string false "functional module" Enums(create_audit_plan,create_workflow,sql_manage,create_optimization,create_pipeline) @Success 200 {object} v1.GetInstanceTipsResV1 @router /v1/projects/{project_name}/instance_tips [get].

GetLicense get sqle license @Summary 获取 sqle license @Description get sqle license @Id getSQLELicenseV1 @Tags configuration @Security ApiKeyAuth @Success 200 {object} v1.GetLicenseResV1 @router /v1/configurations/license [get].

GetLicenseUsageV1 @Summary 获取License使用情况 @Description get usage of license @Tags statistic @Id getLicenseUsageV1 @Security ApiKeyAuth @Success 200 {object} v1.GetLicenseUsageResV1 @router /v1/statistic/license/usage [get].

GetOperationActionList @Summary 获取操作内容列表 @Description Get operation action list @Id getOperationActionList @Tags OperationRecord @Security ApiKeyAuth @Success 200 {object} v1.GetOperationActionListResV1 @Router /v1/operation_records/operation_actions [get].

GetOperationRecordListV1 @Summary 获取操作记录列表 @Description Get operation record list @Id getOperationRecordListV1 @Tags OperationRecord @Security ApiKeyAuth @Param filter_operate_time_from query string false "filter_operate_time_from" @Param filter_operate_time_to query string false "filter_operate_time_to" @Param filter_operate_project_name query string false "filter_operate_project_name" @Param fuzzy_search_operate_user_name query string false "fuzzy_search_operate_user_name" @Param filter_operate_type_name query string false "filter_operate_type_name" @Param filter_operate_action query string false "filter_operate_action" @Param page_index query uint32 true "page_index" @Param page_size query uint32 true "page_size" @Success 200 {object} v1.GetOperationRecordListResV1 @Router /v1/operation_records [get].

@Summary 获取权限动作列表 @Description get permission operations @Id GetOperationsV1 @Tags operation @Security ApiKeyAuth @Success 200 {object} v1.GetOperationsResV1 @Router /v1/operations [get].

GetOperationTypeNameList @Summary 获取操作类型名列表 @Description Get operation type name list @Id GetOperationTypeNameList @Tags OperationRecord @Security ApiKeyAuth @Success 200 {object} GetOperationTypeNamesListResV1 @Router /v1/operation_records/operation_type_names [get].

GetOptimizationRecord @Summary 获取SQL优化记录 @Description get sql optimization record @Id GetOptimizationRecordReq @Tags sql_optimization @Param project_name path string true "project name" @Param optimization_record_id path string true "sql optimization record id" @Param sql query string false "sql" @Security ApiKeyAuth @Success 200 {object} v1.GetOptimizationRecordRes @router /v1/projects/{project_name}/sql_optimization_records/{optimization_record_id}/ [get].

GetOptimizationOverview @Summary 获取SQL优化记录概览 @Description get sql optimization record overview @Tags sql_optimization @Id getOptimizationOverview @Security ApiKeyAuth @Param filter_create_time_from query string true "create time from" @Param filter_create_time_to query string true "create time to" @Param project_name path string true "project name" @Success 200 {object} v1.GetOptimizationOverviewResp @router /v1/projects/{project_name}/statistic/optimization_record_overview [get].

GetOptimizationRecords @Summary 获取SQL优化记录列表 @Description get sql optimization records @Tags sql_optimization @Id getOptimizationRecords @Security ApiKeyAuth @Param fuzzy_search query string false "fuzzy search for optimization_id or create_username" @Param filter_instance_name query string false "filter instance name" @Param filter_create_time_from query string false "filter create time from" @Param filter_create_time_to query string false "filter create time to" @Param page_index query uint32 true "page index" @Param page_size query uint32 true "size of per page" @Param project_name path string true "project name" @Success 200 {object} v1.GetOptimizationRecordsRes @router /v1/projects/{project_name}/sql_optimization_records [get].

GetOptimizationSQLDetail @Summary 获取SQL优化语句详情 @Description get sql optimization record @Id GetOptimizationReq @Tags sql_optimization @Param project_name path string true "project name" @Param optimization_record_id path string true "sql optimization record id" @Param number path string true "optimization record sql number" @Security ApiKeyAuth @Success 200 {object} v1.GetOptimizationSQLRes @router /v1/projects/{project_name}/sql_optimization_records/{optimization_record_id}/sqls/{number}/ [get].

GetOptimizationSQLs @Summary 获取SQL优化语句列表 @Description get sql optimization sqls @Tags sql_optimization @Id getOptimizationSQLs @Security ApiKeyAuth @Param page_index query uint32 true "page index" @Param page_size query uint32 true "size of per page" @Param project_name path string true "project name" @Param optimization_record_id path string true "optimization record id" @Success 200 {object} v1.GetOptimizationSQLsRes @router /v1/projects/{project_name}/sql_optimization_records/{optimization_record_id}/sqls [get].

@Summary 获取流水线详情 @Description get pipeline detail @Id getPipelineDetailV1 @Tags pipeline @Security ApiKeyAuth @Param project_name path string true "project name" @Param pipeline_id path string true "pipeline id" @Success 200 {object} v1.GetPipelineDetailResV1 @router /v1/projects/{project_name}/pipelines/{pipeline_id}/ [get].

@Summary 获取流水线列表 @Description get pipeline list @Id getPipelinesV1 @Tags pipeline @Security ApiKeyAuth @Param project_name path string true "project name" @Param fuzzy_search_name_desc query string false "fuzzy search pipeline name and description" @Param page_index query uint32 true "page index" @Param page_size query uint32 true "size of per page" @Success 200 {object} v1.GetPipelinesResV1 @router /v1/projects/{project_name}/pipelines [get].

GetProjectRuleTemplate @Summary 获取项目规则模板信息 @Description get rule template detail in project @Id getProjectRuleTemplateV1 @Tags rule_template @Security ApiKeyAuth @Param project_name path string true "project name" @Param rule_template_name path string true "rule template name" @Param fuzzy_keyword_rule query string false "fuzzy rule,keyword for desc and annotation" @Success 200 {object} v1.GetProjectRuleTemplateResV1 @router /v1/projects/{project_name}/rule_templates/{rule_template_name}/ [get].

GetProjectRuleTemplates @Summary 项目规则模板列表 @Description get all rule template in a project @Id getProjectRuleTemplateListV1 @Tags rule_template @Security ApiKeyAuth @Param project_name path string true "project name" @Param page_index query uint32 true "page index" @Param page_size query uint32 true "size of per page" @Success 200 {object} v1.GetProjectRuleTemplatesResV1 @router /v1/projects/{project_name}/rule_templates [get].

GetProjectRuleTemplateTips @Summary 获取项目规则模板提示 @Description get rule template tips in project @Id getProjectRuleTemplateTipsV1 @Tags rule_template @Security ApiKeyAuth @Param project_name path string true "project name" @Param filter_db_type query string false "filter db type" @Success 200 {object} v1.GetRuleTemplateTipsResV1 @router /v1/projects/{project_name}/rule_template_tips [get].

GetProjectScoreV1 @Summary 获取项目分数 @Description get project score @Tags statistic @Id GetProjectScoreV1 @Security ApiKeyAuth @Param project_name path string true "project name" @Success 200 {object} v1.GetProjectScoreResV1 @router /v1/projects/{project_name}/statistic/project_score [get].

GetProjectStatisticsV1 @Summary 获取项目统计信息 @Description get project statistics @Tags statistic @Id getProjectStatisticsV1 @Security ApiKeyAuth @Param project_name path string true "project name" @Success 200 {object} v1.GetProjectStatisticsResV1 @router /v1/projects/{project_name}/statistics [get].

GetReportPushConfigList @Summary 获取消息推送配置列表 @Description Get report push config list @Id GetReportPushConfigList @Tags ReportPushConfig @Security ApiKeyAuth @Param project_name path string true "project name" @Success 200 {object} GetReportPushConfigsListResV1 @Router /v1/projects/{project_name}/report_push_configs [get].

GetRiskAuditPlanV1 @Summary 获取扫描任务报告评分低于60的扫描任务 @Description get risk audit plan @Tags statistic @Id getRiskAuditPlanV1 @Security ApiKeyAuth @Param project_name path string true "project name" @Success 200 {object} v1.GetRiskAuditPlanResV1 @router /v1/projects/{project_name}/statistic/risk_audit_plans [get].

GetRoleUserCountV1 @Summary 获取各角色类型对应的成员数量 @Description get role user count @Tags statistic @Id getRoleUserCountV1 @Security ApiKeyAuth @Param project_name path string true "project name" @Success 200 {object} v1.GetRoleUserCountResV1 @router /v1/projects/{project_name}/statistic/role_user [get].

GetRuleKnowledge @Summary 查看规则知识库 @Description get rule knowledge @Id getRuleKnowledgeV1 @Tags rule_template @Security ApiKeyAuth @Param rule_name path string true "rule name" @Param db_type path string true "db type of rule" @Success 200 {object} v1.GetRuleKnowledgeResV1 @router /v1/rule_knowledge/db_types/{db_type}/rules/{rule_name}/ [get].

@Summary 规则列表 @Description get all rule template @Id getRuleListV1 @Tags rule_template @Security ApiKeyAuth @Param filter_db_type query string false "filter db type" @Param fuzzy_keyword_rule query string false "fuzzy rule,keyword for desc and annotation" @Param filter_global_rule_template_name query string false "filter global rule template name" @Param filter_rule_names query string false "filter rule name list" @Success 200 {object} v1.GetRulesResV1 @router /v1/rules [get].

@Summary 获取全局规则模板信息 @Description get global rule template @Id getRuleTemplateV1 @Tags rule_template @Security ApiKeyAuth @Param rule_template_name path string true "rule template name" @Param fuzzy_keyword_rule query string false "fuzzy rule,keyword for desc and annotation" @Success 200 {object} v1.GetRuleTemplateResV1 @router /v1/rule_templates/{rule_template_name}/ [get].

@Summary 全局规则模板列表 @Description get all global rule template @Id getRuleTemplateListV1 @Tags rule_template @Security ApiKeyAuth @Param page_index query uint32 true "page index" @Param page_size query uint32 true "size of per page" @Success 200 {object} v1.GetRuleTemplatesResV1 @router /v1/rule_templates [get].

@Summary 获取全局规则模板提示 @Description get global rule template tips @Id getRuleTemplateTipsV1 @Tags rule_template @Security ApiKeyAuth @Param filter_db_type query string false "filter db type" @Success 200 {object} v1.GetRuleTemplateTipsResV1 @router /v1/rule_template_tips [get].

@Summary 获取规则分类 @Description get rule type by db type @Id getRuleTypeByDBTypeV1 @Tags rule_template @Security ApiKeyAuth @Param db_type path string true "db type" @Success 200 {object} v1.GetRuleTypeByDBTypeResV1 @router /v1/custom_rules/{db_type}/rule_types [get].

GetScheduledTaskDefaultOptionV1 @Summary 获取工单定时上线二次确认默认选项 @Description get scheduled task default option @Tags workflow @Id getScheduledTaskDefaultOptionV1 @Security ApiKeyAuth @Success 200 {object} v1.ScheduledTaskDefaultOptionV1Rsp @Router /v1/configurations/workflows/schedule/default_option [get].

GetSQLAuditRecordsV1 @Summary 获取SQL审核记录列表 @Description get sql audit records @Tags sql_audit_record @Id getSQLAuditRecordsV1 @Security ApiKeyAuth @Param fuzzy_search_tags query string false "fuzzy search tags" @Param filter_sql_audit_status query string false "filter sql audit status" Enums(auditing,successfully) @Param filter_instance_id query uint64 false "filter instance id" @Param filter_create_time_from query string false "filter create time from" @Param filter_create_time_to query string false "filter create time to" @Param filter_sql_audit_record_ids query string false "filter sql audit record ids" @Param page_index query uint32 true "page index" @Param page_size query uint32 true "size of per page" @Param project_name path string true "project name" @Success 200 {object} v1.GetSQLAuditRecordsResV1 @router /v1/projects/{project_name}/sql_audit_records [get].

GetSQLAuditRecordTagTipsV1 @Summary 获取SQL审核记录标签列表 @Description get sql audit record tag tips @Tags sql_audit_record @Id GetSQLAuditRecordTagTipsV1 @Security ApiKeyAuth @Param project_name path string true "project name" @Success 200 {object} v1.GetSQLAuditRecordTagTipsResV1 @router /v1/projects/{project_name}/sql_audit_records/tag_tips [get].

GetSQLAuditRecordV1 @Summary 获取SQL审核记录信息 @Description get sql audit record info @Tags sql_audit_record @Id getSQLAuditRecordV1 @Security ApiKeyAuth @Param project_name path string true "project name" @Param sql_audit_record_id path string true "sql audit record id" @Success 200 {object} v1.GetSQLAuditRecordResV1 @router /v1/projects/{project_name}/sql_audit_records/{sql_audit_record_id}/ [get].

GetSqlAverageExecutionTimeV1 @Summary 获取sql上线平均耗时，按平均耗时降序排列 @Description get average execution time of sql @Tags statistic @Id getSqlAverageExecutionTimeV1 @Security ApiKeyAuth @Param limit query uint true "the limit of result item number" @Success 200 {object} v1.GetSqlAverageExecutionTimeResV1 @router /v1/statistic/instances/sql_average_execution_time [get].

GetSqlDEVRecordList @Summary 获取开发sql记录 @Description get sql dev record list @Tags SqlDEVRecord @Id GetSqlDEVRecordList @Security ApiKeyAuth @Param project_name path string true "project name" @Param fuzzy_search_sql_fingerprint query string false "fuzzy search sql fingerprint" @Param filter_instance_name query string false "instance name" @Param filter_source query string false "source" Enums(ide_plugin) @Param filter_creator query string false "creator name" @Param filter_last_receive_time_from query string false "last receive time from" @Param filter_last_receive_time_to query string false "last receive time to" @Param sort_field query string false "sort field" Enums(first_appear_timestamp,last_receive_timestamp,fp_count) @Param sort_order query string false "sort order" Enums(asc,desc) @Param page_index query uint32 true "page index" @Param page_size query uint32 true "size of per page" @Success 200 {object} v1.GetSqlDEVRecordListResp @Router /v1/projects/{project_name}/sql_dev_records [get].

GetSQLELicenseInfo get the information needed to generate the sqle license @Summary 获取生成 sqle license需要的的信息 @Description get the information needed to generate the sqle license @Id GetSQLELicenseInfoV1 @Tags configuration @Security ApiKeyAuth @Success 200 file 1 "server info" @router /v1/configurations/license/info [get].

GetSqlExecutionFailPercentV1 @Summary 获取SQL上线失败率,按失败率降序排列 @Description get sql execution fail percent @Tags statistic @Id getSqlExecutionFailPercentV1 @Security ApiKeyAuth @Param limit query uint true "the limit of result item number" @Success 200 {object} v1.GetSqlExecutionFailPercentResV1 @router /v1/statistic/instances/sql_execution_fail_percent [get].

GetSqlFileOrderMethodV1 @Summary 获取文件上线排序方式 @Description get file order method @Accept json @Produce json @Tags task @Id getSqlFileOrderMethodV1 @Security ApiKeyAuth @Success 200 {object} v1.GetSqlFileOrderMethodResV1 @router /v1/tasks/file_order_methods [get].

todo : 该接口已废弃，后续会删除 GetSqlManageList @Deprecated @Summary 获取管控sql列表 @Description get sql manage list @Tags SqlManage @Id GetSqlManageList @Security ApiKeyAuth @Param project_name path string true "project name" @Param fuzzy_search_sql_fingerprint query string false "fuzzy search sql fingerprint" @Param filter_assignee query string false "assignee" @Param filter_instance_name query string false "instance name" @Param filter_source query string false "source" Enums(audit_plan,sql_audit_record) @Param filter_audit_level query string false "audit level" Enums(normal,notice,warn,error) @Param filter_last_audit_start_time_from query string false "last audit start time from" @Param filter_last_audit_start_time_to query string false "last audit start time to" @Param filter_status query string false "status" Enums(unhandled,solved,ignored,manual_audited) @Param filter_rule_name query string false "rule name" @Param filter_db_type query string false "db type" @Param fuzzy_search_endpoint query string false "fuzzy search endpoint" @Param fuzzy_search_schema_name query string false "fuzzy search schema name" @Param sort_field query string false "sort field" Enums(first_appear_timestamp,last_receive_timestamp,fp_count) @Param sort_order query string false "sort order" Enums(asc,desc) @Param page_index query uint32 true "page index" @Param page_size query uint32 true "size of per page" @Success 200 {object} v1.GetSqlManageListResp @Router /v1/projects/{project_name}/sql_manages [get].

GetSqlManageRuleTips @Summary 获取管控规则tips @Description get sql manage rule tips @Id GetSqlManageRuleTips @Tags SqlManage @Security ApiKeyAuth @Param project_name path string true "project name" @Success 200 {object} v1.GetSqlManageRuleTipsResp @Router /v1/projects/{project_name}/sql_manages/rule_tips [get].

GetSqlManageSqlAnalysisV1 @Summary 获取SQL管控SQL分析 @Description get sql manage analysis @Id GetSqlManageSqlAnalysisV1 @Tags SqlManage @Param project_name path string true "project name" @Param sql_manage_id path string true "sql manage id" @Security ApiKeyAuth @Success 200 {object} GetSqlManageSqlAnalysisResp @Router /v1/projects/{project_name}/sql_manages/{sql_manage_id}/sql_analysis [get].

@Summary 获取Sql审核白名单 @Description get all whitelist @Id getAuditWhitelistV1 @Tags audit_whitelist @Security ApiKeyAuth @Param project_name path string true "project name" @Param fuzzy_search_value query string false "fuzzy value" @Param filter_match_type query string false "match type" @Param page_index query string true "page index" @Param page_size query string true "page size" @Success 200 {object} v1.GetAuditWhitelistResV1 @router /v1/projects/{project_name}/audit_whitelist [get].

GetSummaryOfWorkflowTasksV1 @Deprecated @Summary 获取工单数据源任务概览 @Description get summary of workflow instance tasks @Tags workflow @Id getSummaryOfInstanceTasksV1 @Security ApiKeyAuth @Param workflow_name path string true "workflow name" @Param project_name path string true "project name" @Success 200 {object} v1.GetWorkflowTasksResV1 @router /v1/projects/{project_name}/workflows/{workflow_name}/tasks [get].

@Summary 查询系统功能支持情况信息 @Description get module status for modulealities in the system @Id getSystemModuleStatus @Tags system @Security ApiKeyAuth @Param db_type query string false "db type" Enums(MySQL,Oracle,TiDB,OceanBase For MySQL,PostgreSQL,DB2,SQL Server) @Param module_name query string false "module name" Enums(execute_sql_file_mode,sql_optimization) @Success 200 {object} v1.GetModuleStatusResV1 @router /v1/system/module_status [get].

@Summary 获取系统变量 @Description get system variables @Id getSystemVariablesV1 @Tags configuration @Security ApiKeyAuth @Success 200 {object} v1.GetSystemVariablesResV1 @router /v1/configurations/system_variables [get].

GetTableMetadata get table metadata @Summary 获取表元数据 @Description get table metadata @Id getTableMetadata @Tags instance @Param project_name path string true "project name" @Param instance_name path string true "instance name" @Param schema_name path string true "schema name" @Param table_name path string true "table name" @Security ApiKeyAuth @Success 200 {object} v1.GetTableMetadataResV1 @router /v1/projects/{project_name}/instances/{instance_name}/schemas/{schema_name}/tables/{table_name}/metadata [get].

@Summary 获取Sql扫描任务信息 @Description get task @Tags task @Id getAuditTaskV1 @Security ApiKeyAuth @Param task_id path string true "task id" @Success 200 {object} v1.GetAuditTaskResV1 @router /v1/tasks/audits/{task_id}/ [get].

GetTaskAnalysisData get SQL explain and related table metadata for analysis @Summary 获取task相关的SQL执行计划和表元数据 @Description get SQL explain and related table metadata for analysis @Id getTaskAnalysisData @Tags task @Param task_id path string true "task id" @Param number path uint true "sql number" @Security ApiKeyAuth @Success 200 {object} v1.GetTaskAnalysisDataResV1 @router /v1/tasks/audits/{task_id}/sqls/{number}/analysis [get].

@Summary 获取指定扫描任务的SQLs信息 @Description get information of all SQLs belong to the specified audit task @Tags task @Id getAuditTaskSQLsV1 @Security ApiKeyAuth @Param task_id path string true "task id" @Param filter_exec_status query string false "filter: exec status of task sql" Enums(initialized,doing,succeeded,failed,manually_executed) @Param filter_audit_status query string false "filter: audit status of task sql" Enums(initialized,doing,finished) @Param filter_audit_level query string false "filter: audit level of task sql" Enums(normal,notice,warn,error) @Param no_duplicate query boolean false "select unique (fingerprint and audit result) for task sql" @Param page_index query string true "page index" @Param page_size query string true "page size" @Success 200 {object} v1.GetAuditTaskSQLsResV1 @router /v1/tasks/audits/{task_id}/sqls [get].

@Summary 获取用户提示列表 @Description get user tip list @Tags user @Id getUserTipListV1 @Security ApiKeyAuth @Param filter_project query string true "project name" @Success 200 {object} v1.GetUserTipsResV1 @router /v1/user_tips [get].

GetWechatAuditConfigurationV1 @Summary 获取微信审核配置 @Description get wechat audit configuration @Id getWechatAuditConfigurationV1 @Tags configuration @Security ApiKeyAuth @Success 200 {object} v1.GetWechatAuditConfigurationResV1 @router /v1/configurations/wechat_audit [get].

GetWorkflowAuditPassPercentV1 @Summary 获取工单审核通过率 @Description get workflow audit pass percent @Tags statistic @Id getWorkflowAuditPassPercentV1 @Security ApiKeyAuth @Success 200 {object} v1.GetWorkflowAuditPassPercentResV1 @router /v1/statistic/workflows/audit_pass_percent [get].

GetWorkflowCountsV1 @Summary 获取工单数量统计数据 @Description get workflow counts @Tags statistic @Id getWorkflowCountV1 @Security ApiKeyAuth @Success 200 {object} v1.GetWorkflowCountsResV1 @router /v1/statistic/workflows/counts [get].

GetWorkflowCreatedCountsEachDayV1 @Summary 获取每天工单创建数量 @Description get counts of created workflow each day @Tags statistic @Id getWorkflowCreatedCountEachDayV1 @Security ApiKeyAuth @Param filter_date_from query string true "filter date from.(format:yyyy-mm-dd)" @Param filter_date_to query string true "filter date to.(format:yyyy-mm-dd)" @Success 200 {object} v1.GetWorkflowCreatedCountsEachDayResV1 @router /v1/statistic/workflows/each_day_counts [get].

GetWorkflowDurationOfWaitingForAuditV1 @Summary 获取工单从创建到审核结束的平均时长 @Description get duration from workflow being created to audited @Tags statistic @Id getWorkflowDurationOfWaitingForAuditV1 @Security ApiKeyAuth @Success 200 {object} v1.GetWorkflowDurationOfWaitingForAuditResV1 @router /v1/statistic/workflows/duration_of_waiting_for_audit [get].

GetWorkflowDurationOfWaitingForExecutionV1 @Deprecated @Summary 获取工单各从审核完毕到执行上线的平均时长 @Description get duration from workflow being created to executed @Tags statistic @Id getWorkflowDurationOfWaitingForExecutionV1 @Security ApiKeyAuth @Success 200 {object} v1.GetWorkflowDurationOfWaitingForExecutionResV1 @router /v1/statistic/workflows/duration_of_waiting_for_execution [get].

GetWorkflowPassPercentV1 @Deprecated @Summary 获取工单通过率 @Description get workflow pass percent @Tags statistic @Id getWorkflowPassPercentV1 @Security ApiKeyAuth @Success 200 {object} v1.GetWorkflowPassPercentResV1 @router /v1/statistic/workflows/pass_percent [get].

GetWorkflowPercentCountedByInstanceTypeV1 @Summary 获取按数据源类型统计的工单百分比 @Description get workflows percent counted by instance type @Tags statistic @Id getWorkflowPercentCountedByInstanceTypeV1 @Security ApiKeyAuth @Success 200 {object} v1.GetWorkflowPercentCountedByInstanceTypeResV1 @router /v1/statistic/workflows/instance_type_percent [get].

GetWorkflowRejectedPercentGroupByCreatorV1 @Summary 获取各个用户提交的工单驳回率，按驳回率降序排列 @Description get workflows rejected percent group by creator.

GetWorkflowRejectedPercentGroupByInstanceV1 @Deprecated @Summary 获取各个数据源相关的工单驳回率，按驳回率降序排列 @Description get workflow rejected percent group by instance.

GetWorkflowStatisticOfInstances @Summary 获取实例上工单的统计信息 @Description Get Workflows Statistic Of Instances @Tags workflow @Id GetWorkflowStatisticOfInstances @Security ApiKeyAuth @Param instance_id query string true "instance id" @Success 200 {object} v1.GetWorkflowStatisticOfInstancesResV1 @router /v1/workflows/statistic_of_instances [get].

GetWorkflowStatusCountV1 @Summary 获取各种状态工单的数量 @Description get count of workflow status @Tags statistic @Id getWorkflowStatusCountV1 @Security ApiKeyAuth @Success 200 {object} v1.GetWorkflowStatusCountResV1 @router /v1/statistic/workflows/status_count [get].

GetWorkflowsV1 @Summary 获取工单列表 @Description get workflow list @Tags workflow @Id getWorkflowsV1 @Security ApiKeyAuth @Param filter_subject query string false "filter subject" @Param filter_workflow_id query string false "filter by workflow_id" @Param fuzzy_search_workflow_desc query string false "fuzzy search by workflow description" @Param filter_create_time_from query string false "filter create time from" @Param filter_create_time_to query string false "filter create time to" @Param filter_task_execute_start_time_from query string false "filter_task_execute_start_time_from" @Param filter_task_execute_start_time_to query string false "filter_task_execute_start_time_to" @Param filter_create_user_id query string false "filter create user id" @Param filter_status query string false "filter workflow status" Enums(wait_for_audit,wait_for_execution,rejected,executing,canceled,exec_failed,finished) @Param filter_current_step_assignee_user_id query string false "filter current step assignee user id" @Param filter_task_instance_id query string false "filter instance id" @Param page_index query uint32 true "page index" @Param page_size query uint32 true "size of per page" @Param project_name path string true "project name" @Param fuzzy_keyword query string false "fuzzy matching subject/workflow_id" @Success 200 {object} v1.GetWorkflowsResV1 @router /v1/projects/{project_name}/workflows [get].

GetWorkflowAttachment @Summary 获取工单的task附件 @Description get workflow attachment @Tags workflow @Id getWorkflowAttachment @Security ApiKeyAuth @Param project_name path string true "project name" @Param workflow_id path string true "workflow id" @Param task_id path string true "task id" @Success 200 {file} file "get workflow attachment" @Router /v1/projects/{project_name}/workflows/{workflow_id}/tasks/{task_id}/attachment [get].

@Summary 获取审批流程模板详情 @Description get workflow template detail @Tags workflow @Id getWorkflowTemplateV1 @Security ApiKeyAuth @Param project_name path string true "project name" @Success 200 {object} v1.GetWorkflowTemplateResV1 @router /v1/projects/{project_name}/workflow_template [get].

GetWorkflowV1 @Deprecated @Summary 获取工单详情 @Description get workflow detail @Tags workflow @Id getWorkflowV1 @Security ApiKeyAuth @Param workflow_name path string true "workflow name" @Param project_name path string true "project name" @Success 200 {object} GetWorkflowResV1 @router /v1/projects/{project_name}/workflows/{workflow_name}/ [get].

ListTableBySchema list table by schema @Summary 获取数据库下的所有表 @Description list table by schema @Id listTableBySchema @Tags instance @Param project_name path string true "project name" @Param instance_name path string true "instance name" @Param schema_name path string true "schema name" @Security ApiKeyAuth @Success 200 {object} v1.ListTableBySchemaResV1 @router /v1/projects/{project_name}/instances/{instance_name}/schemas/{schema_name}/tables [get].

内部接口.

ParseProjectRuleTemplateFile parse rule template @Summary 解析规则模板文件 @Description parse rule template @Id importProjectRuleTemplateV1 @Tags rule_template @Accept mpfd @Security ApiKeyAuth @Param rule_template_file formData file true "SQLE rule template file" @Success 200 {object} v1.ParseProjectRuleTemplateFileResV1 @router /v1/rule_templates/parse [post].

todo: 后续该接口会废弃 @Deprecated @Summary 增量同步SQL到扫描任务 @Description partial sync audit plan SQLs @Id partialSyncAuditPlanSQLsV1 @Tags audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param audit_plan_name path string true "audit plan name" @Param sqls body v1.PartialSyncAuditPlanSQLsReqV1 true "partial sync audit plan SQLs request" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/audit_plans/{audit_plan_name}/sqls/partial [post].

@Deprecated @Summary 审批驳回 @Description reject workflow @Tags workflow @Id rejectWorkflowV1 @Security ApiKeyAuth @Param workflow_name path string true "workflow name" @Param project_name path string true "project name" @Param workflow_step_id path string true "workflow step id" @param workflow_approve body v1.RejectWorkflowReqV1 true "workflow approve request" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/workflows/{workflow_name}/steps/{workflow_step_id}/reject [post].

TODO 和DMS一起抽离出一个工具函数.

SetLicense set sqle license @Summary 导入 sqle license @Description set sqle license @Id setSQLELicenseV1 @Tags configuration @Accept mpfd @Security ApiKeyAuth @Param license_file formData file true "SQLE license file" @Success 200 {object} controller.BaseRes @router /v1/configurations/license [post].

@Summary 优化SQL @Description optimize sql @Id OptimizeSQLReq @Description 1.

StatisticAuditPlanV1 @Summary 获取各类型数据源上的扫描任务数量 @Description statistic audit plan @Tags statistic @Id statisticAuditPlanV1 @Security ApiKeyAuth @Param project_name path string true "project name" @Success 200 {object} v1.StatisticAuditPlanResV1 @router /v1/projects/{project_name}/statistic/audit_plans [get].

StatisticRiskWorkflowV1 @Summary 获取存在风险的工单 @Description statistic risk workflow @Tags statistic @Id statisticRiskWorkflowV1 @Security ApiKeyAuth @Param project_name path string true "project name" @Success 200 {object} v1.StatisticRiskWorkflowResV1 @router /v1/projects/{project_name}/statistic/risk_workflow [get].

StatisticsAuditedSQLV1 @Summary 获取审核SQL总数，以及触发审核规则的SQL数量 @Description statistics audited sql @Tags statistic @Id statisticsAuditedSQLV1 @Security ApiKeyAuth @Param project_name path string true "project name" @Success 200 {object} v1.StatisticsAuditedSQLResV1 @router /v1/projects/{project_name}/statistic/audited_sqls [get].

StatisticWorkflowStatusV1 @Summary 获取项目下工单各个状态的数量 @Description statistic workflow status @Tags statistic @Id statisticWorkflowStatusV1 @Security ApiKeyAuth @Param project_name path string true "project name" @Success 200 {object} v1.GetWorkflowStatusCountResV1 @router /v1/projects/{project_name}/statistic/workflow_status [get].

TerminateMultipleTaskByWorkflowV1 @Summary 终止工单下多个上线任务 @Description terminate multiple task by project and workflow @Tags workflow @Id terminateMultipleTaskByWorkflowV1 @Security ApiKeyAuth @Param workflow_id path string true "workflow id" @Param project_name path string true "project name" @Success 200 {object} controller.BaseRes @Router /v1/projects/{project_name}/workflows/{workflow_id}/tasks/terminate [post].

TerminateSingleTaskByWorkflowV1 @Summary 终止单个上线任务 @Description execute one task on workflow @Tags workflow @Id terminateSingleTaskByWorkflowV1 @Security ApiKeyAuth @Param workflow_id path string true "workflow id" @Param project_name path string true "project name" @Param task_id path string true "task id" @Success 200 {object} controller.BaseRes @Router /v1/projects/{project_name}/workflows/{workflow_id}/tasks/{task_id}/terminate [post].

@Summary 测试扫描任务消息推送 @Description Test audit task message push @Id testAuditPlanNotifyConfigV1 @Tags audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param audit_plan_name path string true "audit plan name" @Success 200 {object} v1.TestAuditPlanNotifyConfigResV1 @router /v1/projects/{project_name}/audit_plans/{audit_plan_name}/notify_config/test [get].

TestDingTalkConfigV1 @Summary 测试 DingTalk 配置 @Description test DingTalk configuration @Accept json @Id testDingTalkConfigV1 @Tags configuration @Security ApiKeyAuth @Success 200 {object} v1.TestDingTalkConfigResV1 @router /v1/configurations/ding_talk/test [post].

TestFeishuAuditConfigV1 @Summary 测试飞书审批配置 @Description test feishu audit configuration @Accept json @Id testFeishuAuditConfigV1 @Tags configuration @Security ApiKeyAuth @Param req body v1.TestFeishuConfigurationReqV1 true "test feishu configuration req" @Success 200 {object} v1.TestFeishuConfigResV1 @router /v1/configurations/feishu_audit/test [post].

TestWechatAuditConfigV1 @Summary 测试微信审批配置 @Description test wechat audit configuration @Accept json @Id testWechatAuditConfigV1 @Tags configuration @Security ApiKeyAuth @Param req body v1.TestWechatConfigurationReqV1 true "test wechat configuration req" @Success 200 {object} v1.TestWechatConfigResV1 @router /v1/configurations/wechat_audit/test [post].

@Deprecated v3.2407 @Summary 触发扫描任务 @Description trigger audit plan @Id triggerAuditPlanV1 @Tags audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param audit_plan_name path string true "audit plan name" @Success 200 {object} v1.TriggerAuditPlanResV1 @router /v1/projects/{project_name}/audit_plans/{audit_plan_name}/trigger [post].

@Summary 更新扫描任务 @Description update audit plan @Id updateAuditPlanV1 @Tags audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param audit_plan_name path string true "audit plan name" @param audit_plan body v1.UpdateAuditPlanReqV1 true "update audit plan" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/audit_plans/{audit_plan_name}/ [patch].

@Summary 更新扫描任务通知设置 @Description update audit plan notify config @Id updateAuditPlanNotifyConfigV1 @Tags audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param audit_plan_name path string true "audit plan name" @param config body v1.UpdateAuditPlanNotifyConfigReqV1 true "update audit plan notify config" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/audit_plans/{audit_plan_name}/notify_config [patch].

@Summary 更新扫描任务状态 @Description stop/start audit plan @Id updateAuditPlanStatusV1 @Tags instance_audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param instance_audit_plan_id path string true "instance audit plan id" @Param audit_plan_id path string true "audit plan id" @param audit_plan body v1.UpdateAuditPlanStatusReqV1 true "update audit plan status" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/instance_audit_plans/{instance_audit_plan_id}/audit_plans/{audit_plan_id}/ [patch].

@Summary 修改扫描任务中某条SQL的相关信息 @Description modify the relevant information of a certain SQL in the audit task @Tags task @Id updateAuditTaskSQLsV1 @Accept json @Param task_id path string true "task id" @Param number path string true "sql number" @Param audit_plan body v1.UpdateAuditTaskSQLsReqV1 true "modify the relevant information of a certain SQL in the audit task" @Security ApiKeyAuth @Success 200 {object} controller.BaseRes @router /v1/tasks/audits/{task_id}/sqls/{number} [patch].

@Summary 更新SQL白名单 @Description update sql whitelist by id @Accept json @Id UpdateAuditWhitelistByIdV1 @Tags audit_whitelist @Security ApiKeyAuth @Param project_name path string true "project name" @Param audit_whitelist_id path string true "sql audit whitelist id" @Param instance body v1.UpdateAuditWhitelistReqV1 true "update sql whitelist req" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/audit_whitelist/{audit_whitelist_id}/ [patch].

UpdateBlacklist @Summary 更新黑名单 @Description update a blacklist @Accept json @Id updateBlacklistV1 @Tags blacklist @Security ApiKeyAuth @Param project_name path string true "project name" @Param blacklist_id path string true "blacklist id" @Param instance body v1.UpdateBlacklistReqV1 true "update blacklist req" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/blacklist/{blacklist_id}/ [patch].

UpdateCompanyNotice @Summary 更新企业公告 @Description update company notice info @Id updateCompanyNotice @Tags companyNotice @Security ApiKeyAuth @Accept json @Produce json @Param companyNotice body v1.UpdateCompanyNoticeReq true "company notice" @Success 200 {object} controller.BaseRes @Router /v1/company_notice [patch].

@Summary 更新自定义规则 @Description update custom rule @Id updateCustomRuleV1 @Tags rule_template @Security ApiKeyAuth @Param rule_id path string true "rule id" @Param instance body v1.UpdateCustomRuleReqV1 true "update custom rule" @Success 200 {object} controller.BaseRes @router /v1/custom_rules/{rule_id} [patch].

UpdateCustomRuleKnowledgeV1 @Summary 更新自定义规则知识库 @Description update custom rule knowledge @Id updateCustomRuleKnowledge @Tags rule_template @Security ApiKeyAuth @Param rule_name path string true "rule name" @Param db_type path string true "db type of rule" @Param req body v1.UpdateRuleKnowledgeReq true "update rule knowledge" @Success 200 {object} controller.BaseRes @router /v1/rule_knowledge/db_types/{db_type}/custom_rules/{rule_name}/ [patch].

UpdateDingTalkConfigurationV1 @Summary 添加或更新 DingTalk 配置 @Description update DingTalk configuration @Accept json @Id updateDingTalkConfigurationV1 @Tags configuration @Security ApiKeyAuth @Param instance body v1.UpdateDingTalkConfigurationReqV1 true "update DingTalk configuration req" @Success 200 {object} controller.BaseRes @router /v1/configurations/ding_talk [patch].

UpdateFeishuAuditConfigurationV1 @Summary 添加或更新飞书配置 @Description update feishu audit configuration @Accept json @Id updateFeishuAuditConfigurationV1 @Tags configuration @Security ApiKeyAuth @Param param body v1.UpdateFeishuConfigurationReqV1 true "update feishu audit configuration req" @Success 200 {object} controller.BaseRes @router /v1/configurations/feishu_audit [patch].

@Summary 更新实例扫描任务配置 @Description update instance audit plan @Id updateInstanceAuditPlanV1 @Tags instance_audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param instance_audit_plan_id path string true "instance audit plan id" @param audit_plan body v1.UpdateInstanceAuditPlanReqV1 true "update instance audit plan" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/instance_audit_plans/{instance_audit_plan_id}/ [put].

@Summary 更新实例扫描任务状态 @Description stop/start instance audit plan @Id updateInstanceAuditPlanStatusV1 @Tags instance_audit_plan @Security ApiKeyAuth @Param project_name path string true "project name" @Param instance_audit_plan_id path string true "instance audit plan id" @param audit_plan body v1.UpdateInstanceAuditPlanStatusReqV1 true "update instance audit plan" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/instance_audit_plans/{instance_audit_plan_id}/ [patch].

@Summary 更新流水线 @Description update pipeline @Id updatePipelineV1 @Tags pipeline @Security ApiKeyAuth @Param project_name path string true "project name" @Param pipeline_id path string true "pipeline id" @Param pipeline body v1.UpdatePipelineReqV1 true "update pipeline" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/pipelines/{pipeline_id}/ [patch].

UpdateProjectRuleTemplate @Summary 更新项目规则模板 @Description update rule template in project @Id updateProjectRuleTemplateV1 @Tags rule_template @Security ApiKeyAuth @Param project_name path string true "project name" @Param rule_template_name path string true "rule template name" @Param req body v1.UpdateProjectRuleTemplateReqV1 true "update rule template request" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/rule_templates/{rule_template_name}/ [patch].

@Summary 更新消息推送配置 @Description update report push config @Id UpdateReportPushConfig @Tags ReportPushConfig @Security ApiKeyAuth @Param project_name path string true "project name" @Param report_push_config_id path string true "report push config id" @Param req body v1.UpdateReportPushConfigReqV1 true "update report push config request" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/report_push_configs/{report_push_config_id}/ [put].

UpdateRuleKnowledgeV1 @Summary 更新规则知识库 @Description update rule knowledge @Id updateRuleKnowledge @Tags rule_template @Security ApiKeyAuth @Param rule_name path string true "rule name" @Param db_type path string true "db type of rule" @Param req body v1.UpdateRuleKnowledgeReq true "update rule knowledge" @Success 200 {object} controller.BaseRes @router /v1/rule_knowledge/db_types/{db_type}/rules/{rule_name}/ [patch].

@Summary 更新全局规则模板 @Description update global rule template @Id updateRuleTemplateV1 @Tags rule_template @Security ApiKeyAuth @Param rule_template_name path string true "rule template name" @Param req body v1.UpdateRuleTemplateReqV1 true "update rule template request" @Success 200 {object} controller.BaseRes @router /v1/rule_templates/{rule_template_name}/ [patch].

UpdateSQLAuditRecordV1 @Summary 更新SQL审核记录 @Description update SQL audit record @Accept json @Id updateSQLAuditRecordV1 @Tags sql_audit_record @Security ApiKeyAuth @Param project_name path string true "project name" @Param sql_audit_record_id path string true "sql audit record id" @Param param body v1.UpdateSQLAuditRecordReqV1 true "update SQL audit record" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/sql_audit_records/{sql_audit_record_id}/ [patch].

UpdateSqlFileOrderV1 @Summary 修改文件上线顺序 @Description update sql file order @Accept json @Produce json @Tags task @Id updateSqlFileOrderV1 @Security ApiKeyAuth @Param project_name path string true "project name" @Param workflow_id path string true "workflow id" @Param task_id path string true "task id" @Param instance body v1.UpdateSqlFileOrderV1Req true "instance body v1.UpdateSqlFileOrderV1Req true" @Success 200 {object} v1.GetSqlFileOrderMethodResV1 @router /v1/projects/{project_name}/workflows/{workflow_id}/tasks/{task_id}/order_file [post].

@Summary 修改系统变量 @Description update system variables @Accept json @Id updateSystemVariablesV1 @Tags configuration @Security ApiKeyAuth @Param instance body v1.UpdateSystemVariablesReqV1 true "update system variables request" @Success 200 {object} controller.BaseRes @router /v1/configurations/system_variables [patch].

UpdateWechatAuditConfigurationV1 @Summary 添加或更新微信配置 @Description update wechat audit configuration @Accept json @Id updateWechatAuditConfigurationV1 @Tags configuration @Security ApiKeyAuth @Param param body v1.UpdateWechatConfigurationReqV1 true "update wechat audit configuration req" @Success 200 {object} controller.BaseRes @router /v1/configurations/wechat_audit [patch].

UpdateWorkflowScheduleV1 @Deprecated @Summary 设置工单数据源定时上线时间（设置为空则代表取消定时时间，需要SQL审核流程都通过后才可以设置） @Description update workflow schedule.

@Summary 更新Sql审批流程模板 @Description update the workflow template @Tags workflow @Id updateWorkflowTemplateV1 @Security ApiKeyAuth @Accept json @Produce json @Param project_name path string true "project name" @Param instance body v1.UpdateWorkflowTemplateReqV1 true "create workflow template" @Success 200 {object} controller.BaseRes @router /v1/projects/{project_name}/workflow_template [patch].

UpdateWorkflowV1 @Deprecated @Summary 更新工单（驳回后才可更新） @Description update workflow when it is rejected to creator.

DirectAuditReqV1.SQLType 为空时默认为此.

AuditResult 用于SQL全生命周期展示的AuditResult.

CreatePipelineReqV1 用于创建流水线的请求结构体.

DeletePipelineReqV1 用于删除流水线的请求结构体.

GetPipelineDetailReqV1 用于请求获取流水线详情的结构体.

GetPipelineDetailResV1 用于响应流水线详情的结构体.

GetPipelinesReqV1 用于请求获取流水线列表的结构体.

GetPipelinesResV1 用于响应流水线列表的结构体.

SQL优化记录结构体.

UpdatePipelineReqV1 用于更新流水线的请求结构体.