Querying the List of Image Security Configuration Detection Results

Function

This API is used to query the list of image security configuration detection results. Currently, the system configuration items and SSH application configuration items of CentOS 7, Debian 10, EulerOS, and Ubuntu16 images can be checked.

URI

GET /v5/{project_id}/image/baseline/risk-configs

Table 1 Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	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.
image_type	Yes	String	Image type. The options are as follows: private_image: private image repository shared_image: shared image repository local_image: local image instance_image: enterprise image
offset	No	Integer	Offset, which specifies the start position of the record to be returned.
limit	No	Integer	Number of records on each page
namespace	No	String	Organization name
image_name	No	String	Image name
image_version	No	String	Image tag name
check_name	No	String	Baseline name
severity	No	String	Risk level. Its value can be: Security Low Medium High
standard	No	String	Standard type. Its value can be: cn_standard: DJCP MLPS compliance standard hw_standard: Cloud security practice standard
instance_id	No	String	Enterprise repository instance ID. This API is not required for SWR shared edition.

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.
region	No	String	Region ID

Response Parameters

Status code: 200

Table 4 Response body parameters
Parameter	Type	Description
total_num	Integer	Total number
data_list	Array of ImageRiskConfigsInfoResponseInfo objects	Configuring the detection list

Table 5 ImageRiskConfigsInfoResponseInfo
Parameter	Type	Description
severity	String	Risk level. Its value can be: Security Low Medium High
check_name	String	Baseline name
check_type	String	Baseline type
standard	String	Standard type. Its value can be: cn_standard: DJCP MLPS compliance standard hw_standard: Cloud security practice standard
check_rule_num	Integer	Number of check items
failed_rule_num	Integer	Number of risk items
check_type_desc	String	Baseline description

Example Requests

Query the security configuration result list of the private image whose namespace is scc_hss_container, image name is euleros, and image version is 2.2.

GET https://{endpoint}/v5/{project_id}/image/baseline/risk-configs?offset=0&limit=200&image_type=private_image&namespace=scc_hss_container&image_name=euleros/test&image_version=2.2.6&enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "check_name" : "CentOS 7",
    "check_rule_num" : 3,
    "check_type" : 3,
    "check_type_desc" : "This document focuses on XXX.",
    "failed_rule_num" : 0,
    "severity" : "Low",
    "standard" : "cn_standard"
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent topic: Container Image

Предыдущая статья

Synchronizing the Image List from SWR

Следующая статья

Querying the Check Item List of a Specified Security Configuration Item of an Image

Была ли эта статья полезна?

Поддержка Юридические документы