Querying the Checklist of a Security Configuration Item
Function
This API is used to query the checklist of a specified security configuration item.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/baseline/risk-config/{check_name}/check-rules
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. Minimum: 20 Maximum: 64 |
check_name |
Yes |
String |
Baseline name, for example, SSH, CentOS 7, and Windows. Minimum: 0 Maximum: 256 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps. Minimum: 0 Maximum: 64 |
standard |
Yes |
String |
Standard type. Its value can be:
Minimum: 0 Maximum: 32 |
result_type |
No |
String |
Result type. Its value can be:
Default: unhandled Minimum: 0 Maximum: 64 |
check_rule_name |
No |
String |
Check item name. Fuzzy match is supported. Minimum: 0 Maximum: 2048 |
severity |
No |
String |
Risk level. Its value can be:
Minimum: 0 Maximum: 255 |
host_id |
No |
String |
Server ID. If this parameter is not specified, all the servers of the user are queried. Minimum: 0 Maximum: 64 |
limit |
No |
Integer |
Number of items per page Minimum: 0 Maximum: 200 Default: 10 |
offset |
No |
Integer |
Offset, which specifies the start position of the record to be returned. Minimum: 0 Maximum: 2000000 Default: 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. Minimum: 32 Maximum: 2097152 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Long |
Total risks Minimum: 0 Maximum: 9223372036854775807 |
data_list |
Array of CheckRuleRiskInfoResponseInfo objects |
Data list Array Length: 0 - 2147483647 |
Parameter |
Type |
Description |
---|---|---|
severity |
String |
Risk level. Its value can be:
Minimum: 0 Maximum: 255 |
check_name |
String |
Baseline name, for example, SSH, CentOS 7, and Windows. Minimum: 0 Maximum: 256 |
check_type |
String |
Baseline type. The values for check_type and check_name are the same for Linux servers. For example, they can both be set to SSH or CentOS 7. For Windows servers, the values for check_type and check_name are different. For example, check_type can be set to Windows Server 2019 R2 or Windows Server 2016 R2. Minimum: 0 Maximum: 256 |
standard |
String |
Standard type. Its value can be:
Minimum: 0 Maximum: 16 |
check_rule_name |
String |
Check item name Minimum: 0 Maximum: 2048 |
check_rule_id |
String |
Check item ID Minimum: 0 Maximum: 64 |
host_num |
Integer |
The number of servers on which the current baseline detection is performed. Minimum: 0 Maximum: 2147483647 |
scan_result |
String |
Detection result. Its value can be:
Minimum: 0 Maximum: 64 |
status |
String |
Status. Its value can be:
Minimum: 0 Maximum: 64 |
enable_fix |
Integer |
Indicates whether one-click repair is supported. 1: yes; 0: no. Minimum: 0 Maximum: 2147483647 |
enable_click |
Boolean |
Whether the Fix, Ignore, and Verify buttons of a check item can be clicked. true: They can be clicked. false: They are grayed out. |
rule_params |
Array of CheckRuleFixParamInfo objects |
Range of parameters applicable to the check items that can be fixed by parameter transfer. This parameter is returned only for check items that support parameter transfer fix. Array Length: 0 - 2147483647 |
Parameter |
Type |
Description |
---|---|---|
rule_param_id |
Integer |
Check item parameter ID Minimum: 0 Maximum: 10 |
rule_desc |
String |
Check item parameter description Minimum: 0 Maximum: 256 |
default_value |
Integer |
Default values of check item parameters Minimum: 0 Maximum: 2147483647 |
range_min |
Integer |
Minimum value of check item parameters Minimum: 0 Maximum: 2147483647 |
range_max |
Integer |
Minimum value of check item parameters Minimum: 0 Maximum: 2147483647 |
Example Requests
This API is used to query the check items 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/check-rules?standard=hw_standard&enterprise_project_id=xxx { "standard" : "hw_standard" }
Example Responses
Status code: 200
checklist of the specified security configuration item
{ "total_num" : 1, "data_list" : [ { "check_rule_id" : "1.1", "check_rule_name" : "Rule:Ensure that permissions on /etc/ssh/sshd_config are configured.", "check_type" : "SSH", "host_num" : 2, "standard" : "hw_standard", "scan_result" : "failed", "severity" : "High", "status" : "unhandled", "enable_fix" : 1, "enable_click" : true, "rule_params" : [ { "rule_param_id" : 1, "rule_desc" : "Set the timeout duration.", "default_value" : 5, "range_min" : 1, "range_max" : 10 }, { "rule_param_id" : 2, "rule_desc" : "Set the number of restarts.", "default_value" : 10, "range_min" : 1, "range_max" : 20 } ] } ] }
SDK Sample Code
The SDK sample code is as follows.
This API is used to query the check items whose baseline name is SSH, check standard is cloud security practice standard, and enterprise project ID is xxx.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.hss.v5.region.HssRegion; import com.huaweicloud.sdk.hss.v5.*; import com.huaweicloud.sdk.hss.v5.model.*; public class ListRiskConfigCheckRulesSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ListRiskConfigCheckRulesRequest request = new ListRiskConfigCheckRulesRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withStandard("<standard>"); request.withResultType("<result_type>"); request.withCheckRuleName("<check_rule_name>"); request.withSeverity("<severity>"); request.withHostId("<host_id>"); request.withLimit(<limit>); request.withOffset(<offset>); try { ListRiskConfigCheckRulesResponse response = client.listRiskConfigCheckRules(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
This API is used to query the check items whose baseline name is SSH, check standard is cloud security practice standard, and enterprise project ID is xxx.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkhss.v5.region.hss_region import HssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkhss.v5 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListRiskConfigCheckRulesRequest() request.enterprise_project_id = "<enterprise_project_id>" request.standard = "<standard>" request.result_type = "<result_type>" request.check_rule_name = "<check_rule_name>" request.severity = "<severity>" request.host_id = "<host_id>" request.limit = <limit> request.offset = <offset> response = client.list_risk_config_check_rules(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
This API is used to query the check items whose baseline name is SSH, check standard is cloud security practice standard, and enterprise project ID is xxx.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListRiskConfigCheckRulesRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest request.Standard = "<standard>" resultTypeRequest:= "<result_type>" request.ResultType = &resultTypeRequest checkRuleNameRequest:= "<check_rule_name>" request.CheckRuleName = &checkRuleNameRequest severityRequest:= "<severity>" request.Severity = &severityRequest hostIdRequest:= "<host_id>" request.HostId = &hostIdRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest response, err := client.ListRiskConfigCheckRules(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
checklist of the specified security configuration item |
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