组件

查询组件列表

基本信息

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

请求参数

Headers

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

Body

参数名称	说明	in	是否必须	类型	schema
req	组件列表查询参数	body	true	MappingComponentQueryReq	MappingComponentQueryReq

schema属性说明

MappingComponentQueryReq

参数名称	说明	in	是否必须	类型	schema
componentName	组件名称	body	false	string
componentVersion	组件版本	body	false	string
licenseTypeList	许可证类型 [1, 2, 3]，1：宽松型，2：弱传染性，3：强传染型	body	false	array
pageNum		body	false	int32
pageSize		body	false	int32
repairSuggestionLevel	修复建议等级筛选项：全部（0），强烈建议修复(1)、建议修复(2)、可选修复(3)、无风险(4)	body	false	int32
taskInstanceId	任务实例ID	body	true	int64
vendor	组件厂商	body	false	string
vulLevelList	漏洞等级 ["CRITICAL", "HIGH", "MEDIUM", "LOW"]	body	false	array
riskType	组件风险类型：全部（0），安全风险(1)、合规风险(2)	body	false	int32
matchingWayFilterList	【匹配方式】+【依赖方式】筛选项，枚举有3种: 文件(file)，直接依赖（direct），传递依赖（indirect)	body	false	array	string

请求示例

json

{
	"componentName": "",
	"componentVersion": "",
	"licenseTypeList": [],
	"pageNum": 0,
	"pageSize": 0,
	"repairSuggestionLevel": 1,
	"taskInstanceId": 0,
	"vendor": "",
	"vulLevelList": []
}

响应数据

响应状态码

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

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

响应参数

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

schema属性说明

CommonPage«MappingComponentQueryResp»

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

MappingComponentQueryResp

参数名称	说明	类型	schema
componentId	组件ID	string
componentName	组件名称	string
componentVersion	组件版本	string
isEol	组件是否停止维护，0：否；1：是	int32
isExclusive	是否只有CSSA独家漏洞，0：否；1：是	int32
licenseRelationExpression	许可证关系表达式	array	LicenseRelationExpressionItemDTO
licenseTypeList	许可证类型信息	array	LicenseTypeDTO
repairSuggestionLevel	修复建议等级：强烈建议修复(1)、建议修复(2)、可选修复(3)、无风险(4)	int32
matchingWayList	匹配方式 ["file"]	array
programingLanguageList	编程语言列表	array
taskId	任务ID	int64
taskInstanceId	任务实例ID	int64
vendor	组件厂商	string
vulCriticalCount	超危漏洞数	int32
vulHighCount	高危漏洞数量	int32
vulLowCount	低危漏洞数量	int32
vulMediumCount	中危漏洞数量	int32
programingLanguageList	编程语言列表["Python"]	array	string

LicenseTypeDTO

参数名称	说明	类型
licenseName	组件许可证名称	string
licenseType	许可证类型 [1, 2, 3]，1：宽松型，2：弱传染性，3：强传染型	string
seriesName	系列-名称	string

LicenseRelationExpressionItemDTO

参数名称	说明	类型
level	表达式项展示层级	int32
type	表达式项类别，license-许可证，logical-逻辑运算符，openBracket-左括号，closeBracket-右括号	string
value	表达式项值	string
uid	表达式项值唯一键	string

成功响应示例

json

{
  "code": "100000",
  "message": "Operation succeeded.",
  "data": {
    "pageNum": 1,
    "pageSize": 1,
    "totalPage": 404,
    "total": 404,
    "list": [
      {
        "taskId": null,
        "taskInstanceId": null,
        "componentId": "afd6aed13591e9978301231d25a6a2d2",
        "componentName": "actuator-sofa-boot-starter",
        "componentVersion": "",
        "vendor": "com.alipay.sofa",
        "isEol": 0,
        "vulLowCount": 0,
        "vulMediumCount": 0,
        "vulHighCount": 0,
        "vulCriticalCount": 0,
        "repairSuggestionLevel": 4,
				"programingLanguageList": [
					"Java",
					"Python"
				],
        "licenseTypeList": [
          {
            "licenseName": "Linux-syscall-note",
            "licenseType": 4,
            "seriesName": null
          }
        ],
        "licenseRelationExpression": [
          {
            "level": 0,
            "type": "license",
            "value": "Linux-syscall-note",
            "uid": null
          }
        ]
      }
    ]
  },
  "success": true
}

失败响应示例

json

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

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

{
  "code": "150000",
  "message": "未找到组件信息",
  "data": null,
  "success": false
}

查询组件详情

基本信息

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

请求参数

Headers

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

Body

参数名称	说明	in	是否必须	类型	schema
req	组件列表查询参数	body	true	MappingComponentQueryReq	MappingComponentQueryReq

schema属性说明

MappingComponentQueryReq

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

请求示例

json

{
	"componentId": "6b7042dcef71fbbfd174992f621b1ddc",
	"taskInstanceId": 32163
}

响应数据

响应状态码

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

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

响应参数

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

schema属性说明

ComponentDetailResp

参数名称	说明	类型	schema
componentId	组件ID	string
componentName	组件名称	string
componentVersion	组件版本	string
isEol	组件是否停止维护，0：否；1：是	int32
isExclusive	是否只有CSSA独家漏洞，0：否；1：是	int32
eolDate	组件停止维护时间	string
licenseRelationExpression	许可证关系表达式	array	LicenseRelationExpressionItemDTO
programingLanguageList	编程语言列表	array
licenseTypeList	许可证类型信息	array	LicenseTypeDTO
repairSuggestionLevel	修复建议等级：强烈建议修复(1)、建议修复(2)、可选修复(3)、无风险(4)	int32
taskId	任务ID	int64
taskInstanceId	任务实例ID	int64
vendor	组件厂商	string
vulCriticalCount	超危漏洞数	int32
vulHighCount	高危漏洞数量	int32
vulLowCount	低危漏洞数量	int32
vulMediumCount	中危漏洞数量	int32

LicenseTypeDTO

参数名称	说明	类型
licenseName	组件许可证名称	string
licenseType	许可证类型 [1, 2, 3]，1：宽松型，2：弱传染性，3：强传染型	string
seriesName	系列-名称	string

LicenseRelationExpressionItemDTO

参数名称	说明	类型
level	表达式项展示层级	int32
type	表达式项类别，license-许可证，logical-逻辑运算符，openBracket-左括号，closeBracket-右括号	string
value	表达式项值	string
uid	表达式项值唯一键	string

成功响应示例

json

{
  "code": "100000",
  "message": "操作成功",
  "data": {
    "taskId": null,
    "taskInstanceId": null,
    "componentId": "6b7042dcef71fbbfd174992f621b1ddc",
    "componentName": "jmockit",
    "componentVersion": "1.40",
    "vendor": "org.jmockit",
    "isEol": 0,
    "eolDate": null,
    "isExclusive": 0,
    "vulLowCount": 0,
    "vulMediumCount": 2,
    "vulHighCount": 1,
    "vulCriticalCount": 0,
    "repairSuggestionLevel": 1,
    "licenseTypeList": [
      {
        "licenseName": "MIT",
        "licenseType": 4,
        "seriesName": null
      }
    ],
    "licenseRelationExpression": [
      {
        "level": 0,
        "type": "license",
        "value": "MIT",
        "uid": "1b508765-d142-4584-ad89-21c03cd338e0"
      }
    ],
    "matchingWayList": [],
    "dependencyWayList": [
      "direct"
    ],
    "programingLanguageList": [
      "Swift",
      "JavaScript",
      "HTML",
      "CSS",
      "Python",
      "Shell",
      "Ruby"
    ]
  },
  "success": true
}

失败响应示例

json

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

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

{
  "code": "150000",
  "message": "未找到组件信息",
  "data": null,
  "success": false
}

组件修复建议查询

基本信息

Path：{{ host }} /cleansourcesca-community/component/suggest
Method：GET

请求参数

Headers

参数名称	参数值
Content-Type	multipart/form-data

Body

参数名称	说明	in	是否必须	类型
componentId	组件ID	body	true	string
taskInstanceId	任务实例ID	body	true	int64
type	升级建议类型（1：短期修复建议；2：长期修复建议）	query	true	integer

请求示例

form-data

componentId: "d36faaa15ad24f005e0e8be33cfb2118"
taskInstanceId: 32898
type: 1

响应数据

响应状态码

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

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

响应参数

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

schema属性说明

ComponentSuggestResponse

参数名称	说明	类型	schema
classSigCompatibility	类签名兼容性（0：不兼容，1：兼容）	int32
eolSuggest	组件EOL修复建议	string
fieldSig	类成员签名兼容性（0：不兼容，1：兼容）	int32
licenseSuggest	许可证修复建议	string
methodSigCompatibility	函数签名兼容性（0：不兼容，1：兼容）	int32
overallCompatibility	整体兼容性（0：不兼容，1：兼容）	int32
runtimeEnvCompatibility	运行环境兼容性（0：不兼容，1：兼容）	int32
vulSuggest	组件升级修复建议	string
unrepairVulLevelCount	未修复漏洞等级计数	VulLevelCountResponse	VulLevelCountResponse
repackVulLevelCount	可修复漏洞等级计数	VulLevelCountResponse	VulLevelCountResponse

VulLevelCountResponse

参数名称	说明	类型
vulCriticalCount	超危漏洞计数	int32
vulHighCount	高危漏洞计数	int32
vulLowCount	低危漏洞计数	int32
vulMediumCount	中危漏洞计数	int32

成功响应示例

json

{
  "code": "100000",
  "message": "操作成功",
  "data": {
    "eolSuggest": null,
    "licenseSuggest": null,
    "vulSuggest": "建议升级至42.3.9版本",
    "runtimeEnvCompatibility": 0,
    "methodSigCompatibility": 0,
    "classSigCompatibility": 0,
    "fieldSig": 0,
    "overallCompatibility": 0,
    "unrepairVulLevelCount": {
      "vulLowCount": 0,
      "vulMediumCount": 0,
      "vulHighCount": 0,
      "vulCriticalCount": 0
    },
    "repackVulLevelCount": {
      "vulLowCount": 0,
      "vulMediumCount": 0,
      "vulHighCount": 3,
      "vulCriticalCount": 3
    }
  },
  "success": true
}

失败响应示例

json

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

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

查询使用组件的任务

基本信息

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

请求参数

Headers

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

Body

参数名称	说明	in	是否必须	类型	schema
param	使用组件的项目列表查询	body	true	ComponentTaskQueryRequest	ComponentTaskQueryRequest

schema属性说明

ComponentTaskQueryRequest

参数名称	说明	in	是否必须	类型
componentId	组件ID	body	true	string
pageNum	当前页码	int32	true
pageSize	每页数据量	int32	true

请求示例

json

{
	"componentId": "d36faaa15ad24f005e0e8be33cfb2118",
	"pageNum": 1,
	"pageSize": 3
}

响应数据

响应状态码

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

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

响应参数

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

schema属性说明

CommonPage«ComponentTaskResponse»

参数名称	说明	类型	schema
list	结果集合	array	ComponentTaskResponse
pageNum	当前页码	int32
pageSize	每页数据量	int32
total	总数	int64
totalPage	总页数	int32

ComponentTaskResponse

参数名称	说明	类型
createTime	任务创建时间	date-time
taskInstanceId	任务实例ID	int64
taskName	任务名称	string

成功响应示例

json

{
  "code": "100000",
  "message": "操作成功",
  "data": {
    "pageNum": 1,
    "pageSize": 3,
    "totalPage": 6,
    "total": 16,
    "list": [
      {
        "taskId": 16010,
        "taskInstanceId": 32377,
        "taskName": "test",
        "createTime": "2025-06-16T14:24:10.000+08:00"
      },
      {
        "taskId": 16102,
        "taskInstanceId": 32469,
        "taskName": "sofa_bin_sim_mmkv_20250623080331786",
        "createTime": "2025-06-23T16:03:32.000+08:00"
      },
      {
        "taskId": 16356,
        "taskInstanceId": 32723,
        "taskName": "sofa_bin_sim_mmkv_20250627182247173",
        "createTime": "2025-06-27T18:22:47.000+08:00"
      }
    ]
  },
  "success": true
}

失败响应示例

json

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

组件升级版本漏洞列表查询

基本信息

Path：{{ host }} /cleansourcesca-community/component/suggest/vul/list
Method：POST

请求参数

Headers

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

Body

参数名称	说明	in	是否必须	类型	schema
queryParam	查询组件升级建议版本漏洞列表入参	body	true	ComponentVulListParam	ComponentVulListParam

schema属性说明

ComponentVulListParam

参数名称	说明	in	是否必须	类型
componentId	组件ID	body	true	string
pageNum	当前页码	int32	true
pageSize	每页数据量	int32	true
suggestType	升级建议类型（1：短期修复建议；2：长期修复建议）	body	true	int32
taskInstanceId	任务实例ID	body	false	int64
vulLevel	筛选的漏洞风险等级（不传默认为全部，CRITICAL：超危；HIGH：高危；MEDIUM：中危；LOW：低危）	body	false	array
vulRepairType	漏洞修复类型（1：可修复的漏洞，2：未修复的漏洞）	body	true	int32

请求示例

json

{
	"componentId": "d36faaa15ad24f005e0e8be33cfb2118",
	"pageNum": 1,
	"pageSize": 10,
	"suggestType": 1,
	"taskInstanceId": 32898,
	"vulLevel": ["HIGH"],
	"vulRepairType": 1
}

响应数据

响应状态码

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

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

响应参数

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

schema属性说明

CommonPage«ComponentSuggestVulListResponse»

参数名称	说明	类型	schema
list	结果集合	array	ComponentSuggestVulListResponse
pageNum	当前页码	int32
pageSize	每页数据量	int32
total	总数	int64
totalPage	总页数	int32

ComponentSuggestVulListResponse

参数名称	说明	类型
isExclusive	是否为CSSA独家漏洞（0：不是，1：是）	int32
num	漏洞编号（可能是cve编号，也可能是cssa编号）	string
vulLevel	漏洞风险等级（CRITICAL：超危；HIGH：高危；MEDIUM：中危；LOW：低危）	string
vulName	漏洞名称	string
vulType	漏洞编号类型（cssa、cve）	string
componentId	当前漏洞所属组件ID	string

成功响应示例

json

{
  "code": "100000",
  "message": "操作成功",
  "data": {
    "pageNum": 1,
    "pageSize": 10,
    "totalPage": 1,
    "total": 3,
    "list": [
      {
        "num": "CVE-2022-21724",
        "vulName": "PostgreSQL JDBC Driver 安全漏洞",
        "vulType": "cve",
        "vulLevel": "HIGH",
        "isExclusive": 0,
        "componentId": "d36faaa15ad24f005e0e8be33cfb2118"
      },
      {
        "num": "CVE-2020-13692",
        "vulName": "PostgreSQL 代码问题漏洞",
        "vulType": "cve",
        "vulLevel": "HIGH",
        "isExclusive": 0,
        "componentId": "d36faaa15ad24f005e0e8be33cfb2118"
      },
      {
        "num": "CVE-2022-31197",
        "vulName": "PostgreSQL JDBC Driver SQL注入漏洞",
        "vulType": "cve",
        "vulLevel": "HIGH",
        "isExclusive": 0,
        "componentId": "d36faaa15ad24f005e0e8be33cfb2118"
      }
    ]
  },
  "success": true
}

失败响应示例

json

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

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

组件 ​

查询组件列表 ​

基本信息 ​

请求参数 ​

Headers ​

Body ​

请求示例 ​

响应数据 ​

响应状态码 ​

响应参数 ​

成功响应示例 ​

失败响应示例 ​

查询组件详情 ​

基本信息 ​

请求参数 ​

Headers ​

Body ​

请求示例 ​

响应数据 ​

响应状态码 ​

响应参数 ​

成功响应示例 ​

失败响应示例 ​

组件修复建议查询 ​

基本信息 ​

请求参数 ​

Headers ​

Body ​

请求示例 ​

响应数据 ​

响应状态码 ​

响应参数 ​

成功响应示例 ​

失败响应示例 ​

查询使用组件的任务 ​

基本信息 ​

请求参数 ​

Headers ​

Body ​

请求示例 ​

响应数据 ​

响应状态码 ​

响应参数 ​

成功响应示例 ​

失败响应示例 ​

组件升级版本漏洞列表查询 ​

基本信息 ​

请求参数 ​

Headers ​

Body ​

请求示例 ​

响应数据 ​

响应状态码 ​

响应参数 ​

成功响应示例 ​

失败响应示例 ​

组件

查询组件列表

基本信息

请求参数

Headers

Body

请求示例

响应数据

响应状态码

响应参数

成功响应示例

失败响应示例

查询组件详情

基本信息

请求参数

Headers

Body

请求示例

响应数据

响应状态码

响应参数

成功响应示例

失败响应示例

组件修复建议查询

基本信息

请求参数

Headers

Body

请求示例

响应数据

响应状态码

响应参数

成功响应示例

失败响应示例

查询使用组件的任务

基本信息

请求参数

Headers

Body

请求示例

响应数据

响应状态码

响应参数

成功响应示例

失败响应示例

组件升级版本漏洞列表查询

基本信息

请求参数

Headers

Body

请求示例

响应数据

响应状态码

响应参数

成功响应示例

失败响应示例