Creating a Scan Task

Function

This API is used to create a scan job.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.
global_image_type	No	String	Definition Image type. Constraints N/A Range local_image: local image registry: repository image Default Value registry

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A
region	No	String	Definition Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
scan_scope	No	Integer	Definition Risk type Constraints N/A Range 0: none 0x7fffffff: all 0x000f0000: vulnerability 0x0000f000: baseline check 0x00000f00: malicious file 0x000000f0: sensitive information 0x0000000f: software compliance Default Value N/A
rate_limit	No	Integer	Definition Scan speed limit (unit: images/hour) Constraints N/A Range 0 to 1000. The value 0 indicates no limit. Default Value N/A
is_all	No	Boolean	Definition Scan all images. Constraints N/A Range true: All images are scanned. false: Specified images are scanned. For details, see the image_info field. Default Value N/A
query_info	No	query_info object	Scanning based on the query result
image_info	No	Array of image_info objects	Image to be scanned

**Table 5** query_info
Parameter	Mandatory	Type	Description
local_image_type	No	String	Definition Local image type Constraints N/A Range swr_image: SWR image other_image: other image Default Value N/A
host_id	No	String	Definition Server ID Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A
host_name	No	String	Definition Server Name Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A
public_ip	No	String	Definition Server EIP. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A
private_ip	No	String	Definition New Private IP Address Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A
cluster_id	No	String	Definition Cluster ID. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A
container_id	No	String	Definition Container ID Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A
container_name	No	String	Definition Container name Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A
pod_id	No	String	Definition pod id Constraints N/A Range The value contains 0 to 64 characters. Default Value N/A
pod_name	No	String	Definition POD name Constraints N/A Range The value contains 0 to 512 characters. Default Value N/A
app_name	No	String	Definition Software name. Constraints N/A Range The value contains 0 to 256 characters. Default Value N/A
has_vul	No	Boolean	Definition Whether there are software vulnerabilities Constraints N/A Range true: A software vulnerability exists. false: No software vulnerability exists. Default Value N/A
namespace	No	String	Definition Organization Constraints N/A Range The value contains 0 to 256 characters. Default Value N/A
image_name	No	String	Definition Image Constraints N/A Range The value contains 0 to 256 characters. Default Value N/A
image_version	No	String	Definition Image tag. Constraints N/A Range The value contains 0 to 256 characters. Default Value N/A
image_type	No	String	Definition Image type. Constraints N/A Range private_image: SWR private image repository shared_image: SWR shared image repository instance_image: SWR enterprise repository harbor: Harbor repository jfrog: JFrog repository Default Value N/A
scan_status	No	String	Definition Scan status Constraints N/A Range unscan: not scanned success: The scan is complete. scanning: scanning failed: The scan failed. download_failed: The download failed. image_oversized: The image is too large. Default Value N/A
image_size	No	Long	Definition Image size Constraints N/A Range Value range: 0 to 9223372036854775807. Default Value N/A
start_latest_update_time	No	Long	Definition Creation start date, in ms. Constraints N/A Range Value range: 0 to 9223372036854775807. Default Value N/A
end_latest_update_time	No	Long	Definition Creation end date, in ms. Constraints N/A Range Value range: 0 to 9223372036854775807. Default Value N/A
start_latest_scan_time	No	Long	Definition The start time of latest scan completion, in ms. Constraints N/A Range Value range: 0 to 9223372036854775807. Default Value N/A
end_latest_scan_time	No	Long	Definition End date of the latest scan completion time, in ms. Constraints N/A Range Value range: 0 to 9223372036854775807. Default Value N/A

**Table 6** image_info
Parameter	Mandatory	Type	Description
id	No	Long	id
image_id	No	String	image id
image_digest	No	String	Image digest.
registry_id	No	String	Image repository ID.
registry_name	No	String	Image repository name.
image_name	No	String	Image name
image_version	No	String	Image version
namespace	No	String	Namespaces
instance_id	No	String	Enterprise instance ID
instance_url	No	String	Downloading the enterprise image URL
registry_type	No	String	Definition Image repository type. Constraints N/A Range SwrPrivate: SWR private repository SwrShared: SWR shared repository SwrEnterprise: SWR enterprise repository Harbor: Harbor repository Jfrog: JFrog repository Other: other repository Default Value N/A