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

Function

This API is used to query the check item list of a specified security configuration item of an image.

URI

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

Table 1 Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
check_name	Yes	String	Baseline name

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	Specifies the organization name. If no image information is available, all images are queried.
image_name	No	String	Image name
image_version	No	String	Image tag name
standard	Yes	String	Standard type. Its value can be: cn_standard: DJCP MLPS compliance standard hw_standard: Cloud security practice standard
result_type	No	String	Result type. Its value can be: pass: The item passed the check. failed: The item failed the check.
check_rule_name	No	String	Check item name. Fuzzy match is supported.
severity	No	String	Risk level. Its value can be: Security Low Medium High Critical
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 risks
data_list	Array of ImageRiskConfigsCheckRulesResponseInfo objects	Data list

Table 5 ImageRiskConfigsCheckRulesResponseInfo
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_name	String	Check items
check_rule_id	String	Check item ID
scan_result	String	Detection result. The options are as follows: pass failed

Example Requests

Query the check items of a specified security configuration item whose organization is aaa, image name is centos7, image version is common, and standard type is cloud standard.

GET https://{endpoint}/v5/{project_id}/image/baseline/risk-configs/{check_name}/rules?offset=0&limit=200&image_type=private_image&namespace=aaa&image_name=centos7/test&image_version=common&standard=hw_standard&enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "check_rule_id" : "1.1",
    "check_rule_name" : "Rule: Password locking policy.",
    "check_name" : "CentOS 7",
    "check_type" : "CentOS 7",
    "standard" : "hw_standard",
    "scan_result" : "failed",
    "severity" : "High"
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent topic: Container Image

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

Querying the List of Image Security Configuration Detection Results

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

Querying the Mirror Configuration Check Report

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

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