任务

查询任务列表

基本信息

Path：{{ host }} /cleansourcesca-community/task/list
Method：POST

请求参数

Headers

参数名称	参数值
Content-Type	application/json

Body

参数名称	说明	in	是否必须	类型	schema
request	任务列表查询参数	body	true	TaskListRequest	TaskListRequest

schema属性说明

TaskListRequest

参数名称	说明	in	是否必须	类型
createTime	创建起始时间段	body	false	array
pageNum		body	false	int32
pageSize		body	false	int32
repairSuggestionLevelList	修复建议等级筛选项：全部（0），强烈建议修复(1)、建议修复(2)、可选修复(3)、无风险(4)	body	false	array
taskName	任务名模糊查询	body	false	string
taskStatus	任务状态查询，默认为null，代表全部查询：finished：扫描完成；failed：扫描失败；executing：扫描中；terminated：已终止；	body	false	string

请求示例

json

{
	"createTime": [],
	"pageNum": 1,
	"pageSize": 10,
	"repairSuggestionLevelList": [],
	"taskName": "",
	"taskStatus": "finished"
}

响应数据

响应状态码

状态码	说明	schema
100000	OK	CommonResult
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
100005	系统异常

操作成功响应状态码：100000
错误码描述：
- 100005：系统异常!

响应参数

参数名称	类型	schema
code	string
data	CommonPage«TaskInstanceListResponse»	CommonPage«TaskInstanceListResponse»
message	string
success	boolean

schema属性说明

CommonPage«TaskInstanceListResponse»

参数名称	类型	schema
list	array	TaskInstanceListResponse
pageNum	int32
pageSize	int32
total	int64
totalPage	int32

TaskInstanceListResponse

参数名称	说明	类型
createTime	创建时间	date-time
creatorId	创建用户ID	int32
creatorName	创建用户名	string
id	任务实例ID	int64
noRiskCount	无风险安全风险计数	int32
optionalCount	可选修复安全风险计数	int32
projectSize	被扫描项目文件总大小，单位Byte	int64
scanTime	扫描耗时，单位毫秒 millisecond	int64
strongRecommendCount	强烈建议修复安全风险计数	int32
suggestedCount	建议修复安全风险计数	int32
taskId	任务ID	int64
taskName	任务名称	string
taskStatus	任务状态，finished：扫描完成；failed：扫描失败；executing：扫描中；terminated：已终止	string

成功响应示例

json

{
  "code": "100000",
  "message": "Operation succeeded.",
  "data": {
    "pageNum": 1,
    "pageSize": 10,
    "totalPage": 1,
    "total": 1,
    "list": [
      {
        "id": 32377,
        "taskName": "fddsgdsuytu/sofa_bin_sim_mmkv/defaultVersion",
        "taskStatus": "finished",
        "createTime": "2025-06-03T23:00:09.000+00:00",
        "projectSize": 0,
        "strongRecommendCount": 0,
        "suggestedCount": 0,
        "optionalCount": 0,
        "noRiskCount": 0,
        "taskId": null,
        "creatorId": 1,
        "creatorName": "admin",
        "scanTime": 103113
      }
    ]
  },
  "success": true
}

失败响应示例

json

{
  "code": "100005",
  "message": "系统异常!",
  "data": null,
  "success": false
}

查询任务详情

基本信息

Path：{{ host }} /cleansourcesca-community/task/detail
Method：POST

请求参数

Headers

参数名称	参数值
Content-Type	application/json

Body

参数名称	说明	in	是否必须	类型	schema
request	任务详情查询参数	body	true	TaskDetailRequest	TaskDetailRequest

schema属性说明

TaskDetailRequest

参数名称	说明	in	是否必须	类型	schema
taskInstanceId	任务实例ID	body	true	int64

请求示例

json

{
	"taskInstanceId": 33163
}

响应数据

响应状态码

状态码	说明	schema
100000	OK	CommonResult
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
100005	系统异常
120003	未找到任务执行实例！

操作成功响应状态码：100000
错误码描述：
- 100005：系统异常!
- 120003：未找到任务执行实例！

响应参数

参数名称	类型	schema
code	string
data	TaskInstanceDetailResponse	TaskInstanceDetailResponse
message	string
success	boolean

schema属性说明

TaskInstanceDetailResponse

参数名称	说明	类型
createTime	创建时间	date-time
creatorId	创建用户ID	int32
creatorName	创建用户名	string
id	任务实例ID	int64
noRiskCount	无风险安全风险计数	int32
optionalCount	可选修复安全风险计数	int32
originProjectSize	项目原始大小	int64
projectSize	被扫描项目文件总大小，单位Byte	int64
scanTime	扫描耗时，单位毫秒 millisecond	int64
strongRecommendCount	强烈建议修复安全风险计数	int32
suggestedCount	建议修复安全风险计数	int32
taskId	任务ID	int64
taskName	任务名称	string
taskStatus	任务状态，finished：扫描完成；failed：扫描失败；executing：扫描中；terminated：已终止	string

成功响应示例

json

{
  "code": "100000",
  "message": "Operation succeeded.",
  "data": {
    "pageNum": 1,
    "pageSize": 10,
    "totalPage": 1,
    "total": 1,
    "list": [
      {
        "id": 32377,
        "taskName": "fddsgdsuytu/sofa_bin_sim_mmkv/defaultVersion",
        "taskStatus": "finished",
        "createTime": "2025-06-03T23:00:09.000+00:00",
        "projectSize": 0,
        "strongRecommendCount": 0,
        "suggestedCount": 0,
        "optionalCount": 0,
        "noRiskCount": 0,
        "taskId": null,
        "creatorId": 1,
        "creatorName": "admin",
        "scanTime": 103113
      }
    ]
  },
  "success": true
}

失败响应示例

json

{
  "code": "100005",
  "message": "系统异常!",
  "data": null,
  "success": false
}

{
  "code": "120003",
  "message": "未找到任务执行实例！",
  "data": null,
  "success": false
}

创建任务

基本信息

Path：{{ host }} /cleansourcesca-community/task/create
Method：POST

请求参数

Headers

参数名称	参数值
Content-Type	application/json

Body

参数名称	说明	in	是否必须	类型	schema
request	创建任务参数	body	true	CreateTaskRequest	CreateTaskRequest

schema属性说明

CreateTaskRequest

参数名称	说明	in	是否必须	类型	schema
callerType	任务的创建方式	body	true	string	CLI发起的扫描该字段为cli，页面发起的扫描该字段为web
fileName	扫描对象的文件名	body	false	string
objectName	上传文件的minio路径	body	false	string
scanType	扫描类型	body	true	string	页面上传代码该字段为sourceCode，页面填写github或者gitlab地址或该字段为git
cloneUrl	git扫描时，仓库的	body	false	string
branchName	git扫描时的分支名	body	false	string

请求示例

json

{
  "fileName":"XStreamer.zip",
  "objectName":"/source-code/e060275e-7025-4e7c-7830-f0ad5a39def8/XStreamer.zip",
  "scanType":"sourceCode",
  "callerType":"web"
}

响应数据

响应状态码

状态码	说明	schema
100000	OK	CommonResult
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
100005	系统异常

操作成功响应状态码：100000
错误码描述：
- 100005：系统异常!

响应参数

参数名称	类型	schema
code	string
data	CommonResult<Pair<Long, Long>>	CommonResult<Pair<Long, Long>>
message	string
success	boolean

schema属性说明

**CommonResult<Pair<Long, Long>>

参数名称	说明	类型	schema
code	错误码	string
message	错误信息	string
success	是否成功	boolean
data	返回实体，key为任务schemaId，value为任务实例id		Pair<Long, Long>

成功响应示例

json

{
    "code": "100000",
    "message": "操作成功",
    "data": {
        "taskId": 16081,
        "taskInstanceId": 32448
    },
    "success": true
}

失败响应示例

json

{
  "code": "100005",
  "message": "系统异常!",
  "data": null,
  "success": false
}

删除任务

基本信息

Path：{{ host }} /cleansourcesca-community/task/delete
Method：POST

请求参数

Headers

参数名称	参数值
Content-Type	application/json

Body

参数名称	说明	in	是否必须	类型	schema
request	删除任务实例请求	body	true	DeleteTaskInstanceReq	DeleteTaskInstanceReq

schema属性说明

DeleteTaskInstanceReq

参数名称	说明	in	是否必须	类型	schema
taskInstanceId	任务实例id	body	true	int64

请求示例

json

{
	"taskInstanceId": 24279
}

响应数据

响应状态码

状态码	说明	schema
100000	OK	CommonResult
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
100005	系统异常
120003	未找到任务执行实例
120007	任务尚未结束，无法删除，请终止任务后重试

操作成功响应状态码：100000
错误码描述：
- 100005：系统异常!
- 120003：未找到任务执行实例
- 120007：任务尚未结束，无法删除，请终止任务后重试

响应参数

参数名称	说明	类型	schema
code		string
data		object
message		string
success		boolean

成功响应示例

json

{
  "code": "100000",
  "message": "Operation succeeded.",
  "data": null,
  "success": true
}

失败响应示例

json

{
  "code": "100005",
  "message": "系统异常!",
  "data": null,
  "success": false
}

{
  "code": "120003",
  "message": "未找到任务执行实例",
  "data": null,
  "success": false
}

{
  "code": "120023",
  "message": "任务尚未结束，无法删除，请终止任务后重试",
  "data": null,
  "success": false
}

终止任务

基本信息

Path：{{ host }} /cleansourcesca-community/task/stop
Method：POST

请求参数

Headers

参数名称	参数值
Content-Type	application/json

Body

参数名称	说明	in	是否必须	类型	schema
request	终止任务实例请求	body	true	StopTaskInstanceReq	StopTaskInstanceReq

schema属性说明

StopTaskInstanceReq

参数名称	说明	in	是否必须	类型	schema
taskInstanceId	任务实例id	body	true	int64

请求示例

json

{
	"taskInstanceId": 24279
}

响应数据

响应状态码

状态码	说明	schema
100000	OK	CommonResult
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
100005	系统异常

操作成功响应状态码：100000
错误码描述：
- 100005：系统异常!

响应参数

参数名称	说明	类型	schema
code		string
data		object
message		string
success		boolean

成功响应示例

json

{
  "code": "100000",
  "message": "Operation succeeded.",
  "data": null,
  "success": true
}

失败响应示例

json

{
  "code": "100005",
  "message": "系统异常!",
  "data": null,
  "success": false
}

通过git地址获取仓库分支列表

基本信息

Path：{{ host }} /cleansourcesca-community/task/git/branch/list
Method：POST

请求参数

Headers

参数名称	参数值
Content-Type	application/json

Body

参数名称	说明	in	是否必须	类型	schema
request	通过git地址获取git仓库分支列表	body	true	GitBranchListRequest	GitBranchListRequest

schema属性说明

GitBranchListRequest

参数名称	说明	in	是否必须	类型	schema
gitRepoUrl	任务实例id	body	true	string

请求示例

json

{
	"gitRepoUrl": "https://gitee.com/dromara/go-view.git"
}

响应数据

响应状态码

状态码	说明	schema
100000	OK	CommonResult
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
100005	系统异常
220000	Git分支列表获取失败!

操作成功响应状态码：100000
错误码描述：
- 100005：系统异常!
- 220000：Git分支列表获取失败!

响应参数

参数名称	说明	类型	schema
code		string
data		object
message		string
success		boolean

成功响应示例

json

{
  "code": "100000",
  "message": "Operation succeeded.",
  "data": [
    "dev",
    "dev-vchart",
    "dev-vchart-supply-types",
    "feat-unify-test",
    "fix-vchart-build-error",
    "master",
    "master-fetch",
    "master-fetch-dev"
  ],
  "success": true
}

失败响应示例

json

{
  "code": "100005",
  "message": "系统异常!",
  "data": null,
  "success": false
}

{
  "code": "220000",
  "message": "Git分支列表获取失败!",
  "data": null,
  "success": false
}

任务 ​

查询任务列表 ​

基本信息 ​

请求参数 ​

Headers ​

Body ​

请求示例 ​

响应数据 ​

响应状态码 ​

响应参数 ​

成功响应示例 ​

失败响应示例 ​

查询任务详情 ​

基本信息 ​

请求参数 ​

Headers ​

Body ​

请求示例 ​

响应数据 ​

响应状态码 ​

成功响应示例 ​

失败响应示例 ​

创建任务 ​

基本信息 ​

请求参数 ​

Headers ​

Body ​

请求示例 ​

响应数据 ​

响应状态码 ​

响应参数 ​

成功响应示例 ​

失败响应示例 ​

删除任务 ​

基本信息 ​

请求参数 ​

Headers ​

Body ​

请求示例 ​

响应数据 ​

响应状态码 ​

响应参数 ​

成功响应示例 ​

失败响应示例 ​

终止任务 ​

基本信息 ​

请求参数 ​

Headers ​

Body ​

请求示例 ​

响应数据 ​

响应状态码 ​

响应参数 ​

成功响应示例 ​

失败响应示例 ​

通过git地址获取仓库分支列表 ​

基本信息 ​

请求参数 ​

Headers ​

Body ​

请求示例 ​

响应数据 ​

响应状态码 ​

响应参数 ​

成功响应示例 ​

失败响应示例 ​

任务

查询任务列表

基本信息

请求参数

Headers

Body

请求示例

响应数据

响应状态码

响应参数

成功响应示例

失败响应示例

查询任务详情

基本信息

请求参数

Headers

Body

请求示例

响应数据

响应状态码

成功响应示例

失败响应示例

创建任务

基本信息

请求参数

Headers

Body

请求示例

响应数据

响应状态码

响应参数

成功响应示例

失败响应示例

删除任务

基本信息

请求参数

Headers

Body

请求示例

响应数据

响应状态码

响应参数

成功响应示例

失败响应示例

终止任务

基本信息

请求参数

Headers

Body

请求示例

响应数据

响应状态码

响应参数

成功响应示例

失败响应示例

通过git地址获取仓库分支列表

基本信息

请求参数

Headers

Body

请求示例

响应数据

响应状态码

响应参数

成功响应示例

失败响应示例