生态投毒
生态投毒近一个月数据统计
基本信息
- Path：{{ host }} /cleansourcesca-community/poisoning/count
- Method：POST
请求参数
Headers
Body
| 参数名称 | 说明 | in | 是否必须 | 类型 | schema |
|---|---|---|---|---|---|
| 暂无 |
请求示例
json
响应数据
响应状态码
| 状态码 | 说明 | schema |
|---|---|---|
| 100000 | OK | CommonResult |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 100005 | 系统异常 |
操作成功响应状态码：100000
错误码描述：
100005：系统异常!
120003：未找到任务执行实例
响应参数
| 参数名称 | 说明 | 类型 | schema |
|---|---|---|---|
| code | string | ||
| data | array | PoisoningCountResponse | |
| message | string | ||
| success | boolean |
schema属性说明
PoisoningCountResponse
| 参数名称 | 说明 | 类型 | schema |
|---|---|---|---|
| count | 统计计数 | int32 | |
| ecosystem | 统计所属生态（npm、 pypi） | string |
响应状态码说明:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | CommonResult«List«PoisoningCountResponse»» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 100000 | 操作成功 | |
| 100005 | 系统异常 |
成功响应示例
json
{
"code": "100000",
"message": "操作成功",
"data": [
{
"ecosystem": "npm",
"count": 0
},
{
"ecosystem": "pypi",
"count": 0
}
],
"success": true
}失败响应示例
json
{
"code": "100005",
"message": "系统异常!",
"data": null,
"success": false
}查询生态投毒列表信息
基本信息
- Path：{{ host }} /cleansourcesca-community/poisoning/info/list
- Method：POST
请求参数
Headers
| 参数名称 | 参数值 |
|---|---|
| Content-Type | application/json |
Body
| 参数名称 | 说明 | in | 是否必须 | 类型 | schema |
|---|---|---|---|---|---|
| req | 生态投毒列表查询参数 | body | true | PoisoningQueryReq | PoisoningQueryReq |
schema属性说明
PoisoningQueryReq
| 参数名称 | 说明 | in | 是否必须 | 类型 | schema |
|---|---|---|---|---|---|
| pageNum | 分页参数，当前页码 | body | true | int32 | |
| pageSize | 分页参数，每页数据量 | body | true | int32 | |
| type | 生态投毒类型（当前可支持参数为： pypi， npm） | body | true | string |
请求示例
json
{
"pageNum": 1,
"pageSize": 10,
"type": "pypi"
}响应数据
响应状态码
| 状态码 | 说明 | schema |
|---|---|---|
| 100000 | OK | CommonResult |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 100005 | 系统异常 |
操作成功响应状态码：100000
错误码描述：
100005：系统异常!
120003：未找到任务执行实例
响应参数
| 参数名称 | 说明 | 类型 | schema |
|---|---|---|---|
| code | string | ||
| data | CommonPage«PoisoningInfoResponse» | CommonPage«PoisoningInfoResponse» | |
| message | string | ||
| success | boolean |
schema属性说明
CommonPage«PoisoningInfoResponse»
| 参数名称 | 说明 | 类型 | schema |
|---|---|---|---|
| list | 结果集合 | array | PoisoningInfoResponse |
| pageNum | 当前页码 | int32 | |
| pageSize | 每页数据量 | int32 | |
| total | 总数 | int64 | |
| totalPage | 总页数 | int32 |
PoisoningInfoResponse
| 参数名称 | 说明 | 类型 | schema |
|---|---|---|---|
| component | 组件名称 | string | |
| createTimestamp | 清源收录日期 | date-time | |
| ecosystem | 投毒组件生态（pypi， npm） | string | |
| fileHash | 投毒组件哈希值 | string | |
| id | 投毒情报主键ID | int64 | |
| malId | 投毒情报唯一键 | int32 | |
| modifyDate | 投毒数据修改日期 | date-time | |
| publishDate | 投毒数据原始发布日期 | date-time | |
| purl | 组件 purl | string | |
| scpDetail | 投毒情报详情 | string | |
| scpName | 投毒情报标题 | string | |
| url | 投毒组件下载地址 | string | |
| version | 组件版本 | string |
成功响应示例
json
{
"code": "100000",
"message": "Operation succeeded.",
"data": {
"list": [
{
"component": "",
"createTimestamp": "",
"ecosystem": "",
"fileHash": "",
"id": 0,
"malId": 0,
"modifyDate": "",
"publishDate": "",
"purl": "",
"scpDetail": "",
"scpName": "",
"url": "",
"version": ""
}
],
"pageNum": 0,
"pageSize": 0,
"total": 0,
"totalPage": 0
},
"success": true
}失败响应示例
json
{
"code": "100005",
"message": "系统异常!",
"data": null,
"success": false
}