Querying the Result List of Server Security Configuration Check
Function
This API is used to query the result list of a user's server security configuration check.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/baseline/risk-configs
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
User project ID |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise project ID |
check_name |
No |
String |
Baseline name |
group_id |
No |
String |
Indicates the policy group ID. |
severity |
No |
String |
Risk level. Its value can be:
|
standard |
No |
String |
Standard type. Its value can be:
|
host_id |
No |
String |
Server ID |
limit |
No |
Integer |
Number of records displayed on each page. The default value is 10. |
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. |
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 the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Long |
Total number of records |
data_list |
Array of SecurityCheckInfoResponseInfo objects |
Server configuration check result 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 |
host_num |
Integer |
Number of affected servers |
scan_time |
Long |
Last scan time |
check_type_desc |
String |
Baseline description |
Example Requests
This API is used to query the server baseline configuration check list whose enterprise project ID is xxx. Data on the first page (the first 10 records) is returned by default.
GET https://{endpoint}/v5/{project_id}/baseline/risk-configs?enterprise_project_id=xxx
Example Responses
Status code: 200
server security configuration check result
{ "total_num" : 1, "data_list" : [ { "check_name" : "Docker", "check_rule_num" : 25, "check_type" : "Docker", "check_type_desc" : "Configuring security audit of Docker's host configurations and container-running-related contents based on Docker Container Security Specifications V1_0.", "failed_rule_num" : 20, "host_num" : 0, "scan_time" : 1661716860935, "severity" : "High", "standard" : "hw_standard" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
server security configuration check result |
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