Querying the Check Result of a Security Configuration Item
Function
This API is used to query the check result of a specified security configuration item.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/baseline/risk-config/{check_name}/detail
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
User project ID |
check_name |
Yes |
String |
Baseline name |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps. |
standard |
Yes |
String |
Standard type. Its value can be:
|
host_id |
No |
String |
Server ID. If this parameter is not specified, all the servers of the user are queried. |
limit |
No |
Integer |
Number of records on each page. |
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 a token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
severity |
String |
Risk level. Its value can be:
|
check_type |
String |
Baseline type |
check_type_desc |
String |
Baseline description |
check_rule_num |
Integer |
Total number of check items |
failed_rule_num |
Integer |
Number of failed check items |
passed_rule_num |
Integer |
Number of passed check items |
ignored_rule_num |
Integer |
Number of ignored check items |
host_num |
Long |
Number of affected servers |
Example Requests
This API is used to query the configuration check list whose baseline name is SSH, check standard is cloud security practice standard, and enterprise project ID is xxx.
GET https://{endpoint}/v5/{project_id}/baseline/risk-config/SSH/detail?standard=hw_standard&enterprise_project_id=xxx
Example Responses
Status code: 200
Security configuration item check result
{ "check_rule_num" : 17, "check_type_desc" : "This policy checks the basic security configuration items of the SSH service to improve the security of the SSH service.", "failed_rule_num" : 15, "host_num" : 2, "ignored_rule_num" : 1, "passed_rule_num" : 14, "severity" : "Medium" }
Status Codes
Status Code |
Description |
---|---|
200 |
Security configuration item 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