DescribeScans - 获取任务列表信息
扫描任务的列表查询接口,用于分页获取某个项目下的扫描记录。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
yundun-codesec:DescribeScans |
get |
*全部资源
|
无 | 无 |
请求语法
GET /v1/projects/{projectId}/scans HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| projectId |
integer |
是 |
项目 ID |
111 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| maxResults |
integer |
否 |
每页数量。默认 20,最大支持 100 |
10 |
| nextToken |
string |
否 |
分页 Token,首页不传 nextToken 省略或为空字符串,翻页原样回传把上一次响应的 nextToken 值不做任何修改地传入下一次请求,响应中 nextToken 为空,已到最后一页 |
eyJ0IjoiMjAyNi0wNy0xNlQwNzo1MzozOC4wMjFaIiwiaSI6MTAwMDQ0OH0 |
| status |
string |
否 |
状态取值:
|
completed |
| taskName |
string |
否 |
任务名称 |
name |
| query |
string |
否 |
可按项目名称、提示词模糊查询 |
name |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| requestId |
string |
Id of the request |
9A1F403F-0A85-5578-8B7C-55E3E9408659 |
| items |
array<object> |
任务列表。 |
|
|
array<object> |
任务信息。 |
||
| id |
integer |
任务 ID。 |
934 |
| projectId |
integer |
项目 ID。 |
1234567 |
| kind |
string |
类型取值:
|
full |
| status |
string |
状态取值:
|
completed |
| codeBundleId |
integer |
代码包 ID |
11 |
| engineSnapshot |
object |
支持的类型。 |
|
| sast |
boolean |
支持 SAST |
true |
| sca |
boolean |
支持 SCA |
true |
| taskName |
string |
任务名称 |
1648622222394847-ha-cn-lm64p7tby01_dsl_kb_video_1773817008236_full |
| createdAt |
string |
创建时间 |
2026-07-28T03:36:31.573Z |
| updatedAt |
string |
更新时间 |
2026-07-28T03:36:31.573Z |
| startedAt |
string |
开始时间 |
2026-07-28T03:36:31.573Z |
| finishedAt |
string |
扫描结束时间 |
2026-07-28T03:36:31.573Z |
| createdBy |
string |
任务创建者的用户 ID |
11111 |
| scanMetrics |
object |
扫描结果统计信息。 |
|
| linesOfCode |
integer |
代码行数。 |
11 |
| fileCount |
integer |
文件数。 |
459 |
| tokenTotal |
integer |
弃用 |
1 |
| credit |
number |
任务消耗 credit 数量。 |
1.25 |
| scanProgress |
integer |
任务进度。 |
100 |
| workerId |
string |
弃用 |
1 |
| currentPhase |
string |
扫描阶段取值如下:
|
finalize |
| totalCount |
integer |
总条数。 |
2 |
| maxResults |
integer |
分页大小。 |
10 |
| nextToken |
string |
分页 token,空表示最后一页 |
eyJ0IjoiMjAyNi0wNy0xNlQwNzo1MzozOC4wMjFaIiwiaSI6MTAwMDQ0OH0 |
示例
正常返回示例
JSON格式
{
"requestId": "9A1F403F-0A85-5578-8B7C-55E3E9408659",
"items": [
{
"id": 934,
"projectId": 1234567,
"kind": "full",
"status": "completed",
"codeBundleId": 11,
"engineSnapshot": {
"sast": true,
"sca": true
},
"taskName": "1648622222394847-ha-cn-lm64p7tby01_dsl_kb_video_1773817008236_full",
"createdAt": "2026-07-28T03:36:31.573Z",
"updatedAt": "2026-07-28T03:36:31.573Z",
"startedAt": "2026-07-28T03:36:31.573Z",
"finishedAt": "2026-07-28T03:36:31.573Z",
"createdBy": "11111",
"scanMetrics": {
"linesOfCode": 11,
"fileCount": 459,
"tokenTotal": 1,
"credit": 1.25
},
"scanProgress": 100,
"workerId": "1",
"currentPhase": "finalize"
}
],
"totalCount": 2,
"maxResults": 10,
"nextToken": "eyJ0IjoiMjAyNi0wNy0xNlQwNzo1MzozOC4wMjFaIiwiaSI6MTAwMDQ0OH0"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter.%s | Invalid parameter:%s. | 无效的参数:%s。 |
| 400 | NotFound.%s | The resource does not exist. | 资源不存在。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。