CreateScan

Updated at:
Copy as MD

Creates a scan task based on a ready code bundle.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-codesec:CreateScan

create

*All Resource

*

None None

Request syntax

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

Path Parameters

Parameter

Type

Required

Description

Example

projectId

integer

Yes

The project ID.

1111

Request parameters

Parameter

Type

Required

Description

Example

kind

string

Yes

The scan type. Valid values:

  • full: Full scan.

  • incremental: Incremental scan.

Valid values:

  • full
  • incremental

full

codeBundleId

integer

Yes

The code bundle ID.

111

taskName

string

Yes

The task name.

name

Response elements

Element

Type

Description

Example

object

Schema of Response

requestId

string

The unique identifier of the request.

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

id

integer

The task ID.

111

projectId

integer

The project ID.

11

kind

string

The scan type. Valid values:

  • full: Full scan.

  • incremental: Incremental scan.

full

status

string

The status. Valid values:

  • running: Running.

  • completed: Completed.

  • failed: Failed.

  • canceling: Canceling.

  • canceled: Canceled.

running

codeBundleId

integer

The code bundle ID.

111

engineSnapshot

object

The supported types.

sast

boolean

Indicates whether SAST is supported.

true

sca

boolean

Indicates whether SCA is supported.

true

taskName

string

The task name.

name

createdAt

string

The creation time.

2026-08-27T00:53:46.774Z

updatedAt

string

The update time.

2026-08-27T00:53:46.774Z

startedAt

string

The start time.

2026-08-27T00:53:46.774Z

finishedAt

string

The scan end time.

2026-08-27T00:53:46.774Z

createdBy

string

The user ID of the task creator.

3221

scanMetrics

object

The scan metrics.

linesOfCode

integer

The number of lines of code.

11

fileCount

integer

The number of files.

1

tokenTotal

integer

[Deprecated].

11

scanProgress

integer

The task progress.

40

workerId

string

[Deprecated].

1

Examples

Success response

JSON format

{
  "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"
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidParameter.%s Invalid parameter:%s. Invalid parameter:%s.
400 NotFound.%s The resource does not exist. The resource does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.