Obtaining Sensitive Information of an Image

Function

This API is used to check sensitive information within an image. To locate a CI/CD image, input its type and ID. For other repositories, specify the image type along with the organization name, image name, and version to find the exact match.

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}/sensitive

**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 128 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
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
image_version	No	String	Definition Image tag name Constraints N/A Range The value can contain 0 to 65,535 characters. Default Value N/A
file_path	No	String	Definition File path. Constraints N/A Range The value can contain 0 to 65,535 characters. Default Value N/A
severity	No	String	Definition Risk level. Constraints N/A Range critical high medium low Default Value N/A
handle_status	No	String	Definition Handled or not. Constraints N/A Range unhandled handled 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 true: yes. Range Minimum value: 0; maximum value: 2,147,483,547
data_list	Array of ImageSensitiveInfo objects	Definition Sensitive image information Range The value range is 0 to 10,241.

**Table 5** ImageSensitiveInfo
Parameter	Type	Description
sensitive_info_id	String	Definition Sensitive event ID. Range The value can contain 0 to 128 characters.
severity	String	Definition Risk level. Range critical high medium low
name	String	Definition Rule name. Range The value can contain 0 to 128 characters.
description	String	Definition Rule Description Range The value can contain 0 to 128 characters.
position	String	Definition Image where a vulnerability exists Range The value can contain 0 to 128 characters.
file_path	String	Definition File path. Range The value can contain 0 to 128 characters.
content	String	Definition Sensitive information Range The value can contain 0 to 128 characters.
latest_scan_time	Long	Definition Last detection time, in ms. Range The value range is 0 to 2,147,483,647.
handle_status	String	Definition Handled or not. Range unhandled handled
operate_accept	String	Definition Operation type. Range ignore: Ignore do_not_ignore: Unignore

Example Requests

Query the sensitive information of a private image.

GET https://{endpoint}/v5/{project_id}/image/{image_id}/sensitive?limit=10&offset=0&image_type=private_image&namespace=scc_hss_container&image_name=proxy-agent&image_version=24.5.0-x86_64&enterprise_project_id=all_granted_eps

Query the sensitive information of the CI/CD image whose image ID is 111.

GET https://{endpoint}/v5/{project_id}/image/{image_id}/sensitive?limit=10&offset=0&image_type=cicd&enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "content" : "--****--",
    "description" : "PKCS8 private key",
    "file_path" : "/home/sensitivecontent.txt",
    "handle_status" : "unhandled",
    "name" : "PKCS8 private key",
    "operate_accept" : "ignore",
    "position" : "sha256:2c07d7001e7b2afbe4a270883dfd2c7281f8cfdbe7a43592bae662badd39dfd2",
    "sensitive_info_id" : "ee02b282-1cf4-4a6a-ac7f-78b42164bb99",
    "severity" : "high"
  } ]
}