Querying the List of Malicious Files in Images

Function

This API is used to query the list of malicious files in an image. If the image is of the CI/CD type, only the image ID needs to be specified; organization name, image name, and version are not required. For other types of images, organization name, image name, and version must be provided.

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

GET /v5/{project_id}/image/{image_id}/malwares

**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
image_id	Yes	String	Definition Image ID. Constraints N/A Range The value can contain 0 to 65,535 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.
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10
offset	No	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0.
image_type	Yes	String	Definition Image type. Constraints N/A Range private_image: SWR private image shared_image: SWR shared image instance_image: SWR enterprise edition image cicd : CI/CD image harbor: Harbor repository image Default Value N/A
file_name	No	String	Definition Filter and query file names (fuzzy match is supported). Constraints N/A Range The value can contain 0 to 65,535 characters. Default Value N/A
namespace	No	String	Definition Organization Constraints N/A Range The value can contain 0 to 65,535 characters. Default Value N/A
image_name	No	String	Definition Image Constraints N/A Range The value can contain 0 to 65,535 characters. Default Value N/A
tag_name	No	String	Definition Image tag name Constraints N/A Range The value can contain 0 to 65,535 characters. Default Value N/A

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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Definition Total number. Range Minimum value: 0; maximum value: 2,147,483,547
data_list	Array of ImageMalwareInfo objects	Definition List. Range The value range is 0 to 10,000.

**Table 5** ImageMalwareInfo
Parameter	Type	Description
file_name	String	Definition File name. Range The value can contain 0 to 256 characters.
file_path	String	Definition File path. Range The value can contain 0 to 256 characters.
size	Integer	Definition File size. Range The value ranges from 0 to 65,535.
description	String	Definition File description. Range The value can contain 0 to 256 characters.

Example Requests

Query the malicious image file list.

GET https://{endpoint}/v5/{project_id}/image/{image_id}/malwares?limit=10&offset=0&namespace=scc_hss_container&image_name=proxy-agent&tag_name=24.5.0-x86_64&image_id=sha256:0b08c2b4162c7007fba407806554a0b4f56bfcfa6b93c2644ebd2d1decd7ee53&image_type=private_image&enterprise_project_id=all_granted_ep

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 16,
  "data_list" : [ {
    "size" : 6331,
    "file_name" : "backupsql.php.php",
    "file_path" : "/root/webshell_samples/php/db/"
  }, {
    "size" : 15410,
    "file_name" : "e4ba288f6d46dc77b403adf7d411a280601c635b.php",
    "file_path" : "/root/webshell_samples/php/db/"
  }, {
    "size" : 21574,
    "file_name" : "2675c799c9866e6a1e2bc344af96a1a5.php",
    "file_path" : "/root/webshell_samples/php/file/"
  }, {
    "size" : 16378,
    "file_name" : "zacosmall.php",
    "file_path" : "/root/webshell_samples/php/file/"
  }, {
    "size" : 21574,
    "file_name" : "2675c799c9866e6a1e2bc344af96a1a5.php",
    "file_path" : "/tmp/"
  }, {
    "size" : 6331,
    "file_name" : "backupsql.php.php",
    "file_path" : "/tmp/"
  }, {
    "size" : 15410,
    "file_name" : "e4ba288f6d46dc77b403adf7d411a280601c635b.php",
    "file_path" : "/tmp/"
  }, {
    "size" : 21574,
    "file_name" : "2675c799c9866e6a1e2bc344af96a1a5.php",
    "file_path" : "/tmp/testlby/"
  }, {
    "size" : 6331,
    "file_name" : "backupsql.php.php",
    "file_path" : "/tmp/testlby/"
  }, {
    "size" : 15410,
    "file_name" : "e4ba288f6d46dc77b403adf7d411a280601c635b.php",
    "file_path" : "/tmp/testlby/"
  } ]
}