Assessing Image Build Command Risks

Function

This API is used to obtain risk information about an image build command.

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/build-command-risks

**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.
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 cicd : CI/CD image registry: repository image The value can contain 1 to 32 characters. Default Value N/A
image_id	No	String	Definition Image ID. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A
risk_name	No	String	Definition Risk Name Constraints N/A Range The value can contain 1 to 512 characters. Default Value N/A
risk_level	No	String	Definition Risk level. Constraints N/A Range critical high medium low The value can contain 1 to 64 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 0 to 2,147,483,547
data_list	Array of ImageBuildCommandRiskResponseInfo objects	Definition Risk list Range The value range is 0 to 200.

**Table 5** ImageBuildCommandRiskResponseInfo
Parameter	Type	Description
latest_scan_time	Long	Definition Last detection time, in ms. Range 0 to 9223372036854775807
image_num	Integer	Definition Number of affected images, that is, the number of images for which the current build instruction is executed. Range 0 to 2097152
risk_id	String	Definition Risk ID Range The value can contain 1 to 64 characters.
rule_id	String	Definition Risk detection rule ID. Range The value can contain 1 to 64 characters.
risk_name	String	Definition Risk Name Range The value can contain 1 to 512 characters.
risk_level	String	Definition Risk level. Range critical high medium low
description	String	Definition Risk Range The value can contain 0 to 65,534 characters.
image_type	String	Definition Image type. Range The value can contain 1 to 32 characters.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "data_list" : [ {
    "image_type" : "registry",
    "risk_id" : "ea967dad-f4bf-4dd1-8900-d15cc6025fa8",
    "rule_id" : "DS002",
    "risk_name" : "Image user should not be 'root'",
    "risk_level" : "high",
    "image_num" : 1,
    "description" : "Running containers with 'root' user can lead to a container escape situation. It is a best practice to run containers as non-root users, which can be done by adding a 'USER' statement to the Dockerfile.",
    "latest_scan_time" : 1691748641788
  } ],
  "total_num" : 1
}