Scanning Images in the Image Repository in Batches

Function

This API is used to scan images in the image repository in batches.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/image/batch-scan

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant project ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
x-auth-token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
repo_type	No	String	Repository type. Currently, SWR image repositories are connected. The options are as follows: SWR: SWR image repository
image_info_list	No	Array of BatchScanSwrImageInfo objects	Specifies the list of images to be scanned. This parameter is mandatory when operate_all is false.
operate_all	No	Boolean	If this parameter is set to true, all filter criteria can be used for full query. If image_info_list is empty, this parameter is mandatory.
namespace	No	String	Organization name
image_name	No	String	Image name
image_version	No	String	Image tag
image_type	Yes	String	Image type. The options are as follows: private_image: private image repository shared_image: shared image repository
scan_status	No	String	Scan status. The options are as follows: unscan success scanning failed download_failed image_oversized
latest_version	No	Boolean	Display latest image versions only
image_size	No	Long	Image size
start_latest_update_time	No	Long	Creation start time.
end_latest_update_time	No	Long	Creation end time.
start_latest_scan_time	No	Long	Specify the start time based on the query condition of latest scan completion.
end_latest_scan_time	No	Long	Specify the end time based on the query condition of latest scan completion.

**Table 5** BatchScanSwrImageInfo
Parameter	Mandatory	Type	Description
namespace	No	String	Namespace
image_name	No	String	Image name
image_version	No	String	Image tag
instance_id	No	String	Enterprise instance ID
instance_url	No	String	Downloading the enterprise image URL

Response Parameters

Status code: 200

successful response

None

Example Requests

Scan private images in batches. The request body transfers the image list and operate_all does not contain any parameter, indicating that the image list needs to be scanned in batches.

POST https://{endpoint}/v5/{project_id}/image/batch-scan

{
  "image_type" : "private_image",
  "image_info_list" : [ {
    "image_name" : "openjdk",
    "image_version" : "v8.8",
    "namespace" : "test"
  }, {
    "image_name" : "openjdk1",
    "image_version" : "v1.0",
    "namespace" : "test1"
  } ]
}

Perform a full scan for private images. The request body does not transfer the image list and operate_all is set to true, indicating that the image list needs to be fully scanned.
```
POST https://{endpoint}/v5/{project_id}/image/batch-scan

{
  "image_type" : "private_image",
  "operate_all" : true
}
```