CreateScan - 创建扫描任务

更新时间:
复制 MD 格式

基于已 ready 的代码包创建扫描任务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-codesec:CreateScan

create

*全部资源

*

无 无

请求语法

POST /v1/projects/{projectId}/scans HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

projectId

integer

是

项目 ID

1111

请求参数

名称

类型

必填

描述

示例值

kind

string

是

类型取值:

  • full :全量

  • incremental:增量

枚举值:

  • full
  • incremental

full

codeBundleId

integer

是

代码包 ID

111

taskName

string

是

任务名称

name

返回参数

名称

类型

描述

示例值

object

Schema of Response

requestId

string

请求唯一标识。

9A1F403F-0A85-5578-8B7C-55E3E9408659

id

integer

任务 ID。

111

projectId

integer

项目 ID

11

kind

string

类型取值:

  • full :全量

  • incremental:增量

full

status

string

状态取值:

  • running:运行中

  • completed:已完成

  • failed:失败

  • canceling:取消中

  • canceled:取消完成

running

codeBundleId

integer

代码包 ID

111

engineSnapshot

object

支持的类型。

sast

boolean

支持 SAST

true

sca

boolean

支持 SCA

true

taskName

string

任务名称

name

createdAt

string

创建时间

2026-08-27T00:53:46.774Z

updatedAt

string

更新时间

2026-08-27T00:53:46.774Z

startedAt

string

开始时间

2026-08-27T00:53:46.774Z

finishedAt

string

扫描结束时间

2026-08-27T00:53:46.774Z

createdBy

string

任务创建者的用户 ID

3221

scanMetrics

object

扫描信息。

linesOfCode

integer

代码行数。

11

fileCount

integer

文件数。

1

tokenTotal

integer

弃用

11

scanProgress

integer

任务进度。

40

workerId

string

弃用

1

示例

正常返回示例

JSON格式

{
  "requestId": "9A1F403F-0A85-5578-8B7C-55E3E9408659",
  "id": 111,
  "projectId": 11,
  "kind": "full",
  "status": "running",
  "codeBundleId": 111,
  "engineSnapshot": {
    "sast": true,
    "sca": true
  },
  "taskName": "name",
  "createdAt": "2026-08-27T00:53:46.774Z",
  "updatedAt": "2026-08-27T00:53:46.774Z",
  "startedAt": "2026-08-27T00:53:46.774Z",
  "finishedAt": "2026-08-27T00:53:46.774Z",
  "createdBy": "3221",
  "scanMetrics": {
    "linesOfCode": 11,
    "fileCount": 1,
    "tokenTotal": 11
  },
  "scanProgress": 40,
  "workerId": "1"
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter.%s Invalid parameter:%s. 无效的参数:%s。
400 NotFound.%s The resource does not exist. 资源不存在。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。