Querying the List of Image Security Configuration Detection Results
Function
This API is used to query the list of image security configuration detection results.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/image/baseline/risk-configs
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Tenant project ID |
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:
|
offset |
No |
Integer |
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0. |
limit |
No |
Integer |
Number of records displayed 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:
|
standard |
No |
String |
Standard type. Its value can be:
|
instance_id |
No |
String |
Enterprise repository instance ID. This API is not required for SWR shared edition. |
Request 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. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Integer |
Total number |
data_list |
Array of ImageRiskConfigsInfoResponseInfo objects |
Configuring the detection list |
Parameter |
Type |
Description |
---|---|---|
severity |
String |
Risk level. Its value can be:
|
check_name |
String |
Baseline name |
check_type |
String |
Baseline type |
standard |
String |
Standard type. Its value can be:
|
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
This API is used to query the list of image configuration results.
{ "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 |
This API is used to query the list of image configuration results. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot