Querying the Security Risk List
Function
This API is used to query the security risk list.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/overview/security/risk/list
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
alarm_risk |
AlarmRiskInfo object |
Definition Intrusion risks. |
baseline_risk |
baseline_risk object |
Definition Unsafe settings. |
asset_risk |
asset_risk object |
Definition Asset risks. |
security_protect_risk |
security_protect_risk object |
Definition Security risks. |
vul_risk |
vul_risk object |
Definition Vulnerability risks. |
image_risk |
image_risk object |
Definition Image risks |
total_risk_num |
Integer |
Definition Total number of risks Range Minimum value: 0; maximum value: 2147483647 |
Parameter |
Type |
Description |
---|---|---|
risk_list |
Array of RiskListInfo objects |
Definition Risk list Range Minimum value: 0; maximum value: 4 |
deduct_score |
Float |
Definition Score deduction Range Minimum value: 0; maximum value: 30 |
policy_list |
Array of PolicyInfo objects |
Definition Policy information. Range Minimum value: 0; maximum value: 32 |
total_risk_num |
Integer |
Definition Total number of risks. Range Minimum value: 0; maximum value: 2147483647 |
Parameter |
Type |
Description |
---|---|---|
risk_list |
Array of RiskListInfo objects |
Definition Baseline risk list Range Minimum value: 0; maximum value: 4 |
deduct_score |
Float |
Definition Score deduction Range Minimum value: 0; maximum value: 20 |
policy_list |
Array of PolicyInfo objects |
Definition List of policies that are not enabled Range Minimum value: 0; maximum value: 32 |
existed_pwd_host_num |
Integer |
Definition Number of servers with weak passwords. Range Minimum value: 0; maximum value: 2147483647 |
un_scanned_baseline_host_num |
Integer |
Definition Number of servers where baseline check is not performed. Range Minimum value: 0; maximum value: 2147483647 |
total_risk_num |
Integer |
Definition Total number of risks. Range Minimum value: 0; maximum value: 2147483647 |
Parameter |
Type |
Description |
---|---|---|
existed_danger_port_host_num |
Integer |
Definition Number of servers with dangerous ports. Range Minimum value: 0; maximum value: 2147483647 |
policy_list |
Array of PolicyInfo objects |
Definition Policy list. Range Minimum value: 0; maximum value: 32 |
deduct_score |
Float |
Definition Score deduction Range Minimum value: 0; maximum value: 10 |
total_risk_num |
Integer |
Definition Total number of risks. Range Minimum value: 0; maximum value: 2147483647 |
Parameter |
Type |
Description |
---|---|---|
policy_id |
String |
Policy ID |
policy_name |
String |
Policy name |
os_type |
String |
OS type |
host_num |
Integer |
Associated servers |
rule_name |
String |
Detection feature rule name, which is separated by commas (,). |
Parameter |
Type |
Description |
---|---|---|
un_open_protection_host_num |
Integer |
Definition Number of unprotected servers. Range Minimum value: 0; maximum value: 2147483647 |
deduct_score |
Float |
Definition Score deduction Range Minimum value: 0; maximum value: 10 |
total_risk_num |
Integer |
Definition Total number of risks. Range Minimum value: 0; maximum value: 2147483647 |
Parameter |
Type |
Description |
---|---|---|
risk_list |
Array of RiskListInfo objects |
Definition Vulnerability risk list Range Minimum value: 0; maximum value: 4 |
deduct_score |
Float |
Definition Score deduction Range Minimum value: 0; maximum value: 20 |
un_scanned_host_num |
Integer |
Definition Number of servers where vulnerability scan is not performed (in the past month) Range Minimum value: 0; maximum value: 2147483647 |
total_risk_num |
Integer |
Definition Total number of risks. Range Minimum value: 0; maximum value: 2147483647 |
Parameter |
Type |
Description |
---|---|---|
severity |
String |
Definition Risk level. Range Length: 0 to 32 characters |
risk_num |
Integer |
Definition Number of risks. Range Minimum value: 0; maximum value: 2147483647 |
effected_host_num |
Integer |
Definition Number of affected assets. Range Minimum value: 0; maximum value: 2147483647 |
Parameter |
Type |
Description |
---|---|---|
deduct_score |
Float |
Definition Score deduction Range Minimum value: 0; maximum value: 10 |
un_scanned_image_num |
Integer |
Definition Number of unscanned images. Range Minimum value: 0; maximum value: 2147483647 |
risk_list |
Array of risk_list objects |
Definition Risk list Range Minimum value: 0; maximum value: 4 |
total_risk_num |
Integer |
Definition Total number of risks. Range Minimum value: 0; maximum value: 2147483647 |
Example Requests
Query the security risk list.
GET https://{endpoint}/v5/{project_id}/overview/security/risk/list
Example Responses
Status code: 200
Request succeeded.
{ "asset_risk" : { "existed_danger_port_host_num" : 0, "existed_eip_host_num" : 0, "deduct_score" : 0, "policy_list" : [ { "type" : "assetmanage_collect", "count" : 0 } ], "total_risk_num" : 0 }, "baseline_risk" : { "risk_list" : [ { "severity" : "High", "effected_host_num" : 1, "risk_num" : 1 }, { "severity" : "Low", "effected_host_num" : 1, "risk_num" : 1 }, { "severity" : "Medium", "effected_host_num" : 11, "risk_num" : 18 } ], "deduct_score" : 20, "policy_list" : [ { "type" : "pwd_check_feature", "count" : 0 } ], "existed_pwd_host_num" : 16, "un_scanned_baseline_host_num" : 3, "total_risk_num" : 39 }, "vul_risk" : { "risk_list" : [ { "severity" : "High", "effected_host_num" : 34, "risk_num" : 500 }, { "severity" : "Medium", "effected_host_num" : 36, "risk_num" : 3569 }, { "severity" : "Low", "effected_host_num" : 35, "risk_num" : 658 } ], "deduct_score" : 20, "un_scanned_host_num" : 2, "total_risk_num" : 4729 }, "alarm_risk" : { "risk_list" : [ { "severity" : "Critical", "effected_host_num" : 35, "risk_num" : 27 }, { "severity" : "High", "effected_host_num" : 35, "risk_num" : 4103 }, { "severity" : "Medium", "effected_host_num" : 35, "risk_num" : 75 }, { "severity" : "Low", "effected_host_num" : 35, "risk_num" : 936 } ], "deduct_score" : 30, "policy_list" : [ { "type" : "webguard_feature", "count" : 0 }, { "type" : "login_check_feature", "count" : 0 }, { "type" : "any_policy", "count" : 0 }, { "type" : "container_running_detect", "count" : 4 }, { "type" : "antiransomware_feature", "count" : 0 } ], "total_risk_num" : 5145 }, "image_risk" : { "risk_list" : [ { "severity" : "High", "image_num" : 507 }, { "severity" : "Medium", "image_num" : 120 }, { "severity" : "Low", "image_num" : 0 } ], "deduct_score" : 10, "un_scanned_image_num" : 5, "total_risk_num" : 632, "total_image_num" : 805 }, "security_protect_risk" : { "un_open_protection_host_num" : 118, "deduct_score" : 10, "total_risk_num" : 118 }, "total_risk_num" : 10663 }
SDK Sample Code
The SDK sample code is as follows.
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 |
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 ListSecurityRiskSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ListSecurityRiskRequest request = new ListSecurityRiskRequest(); try { ListSecurityRiskResponse response = client.listSecurityRisk(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()); } } } |
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 |
# 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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListSecurityRiskRequest() response = client.list_security_risk(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 |
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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListSecurityRiskRequest{} response, err := client.ListSecurityRisk(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 |
Request succeeded. |
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