Querying the Security Risk List

Function

This API is used to query the security risk list.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/overview/security/risk/list

**Table 1** Path Parameters
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

**Table 2** Query Parameters
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

**Table 3** Request header 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

**Table 4** Response body parameters
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

**Table 5** AlarmRiskInfo
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

**Table 6** baseline_risk
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

**Table 7** asset_risk
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

**Table 8** PolicyInfo
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 (,).

**Table 9** security_protect_risk
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

**Table 10** vul_risk
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

**Table 11** RiskListInfo
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

**Table 12** image_risk
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

**Table 13** risk_list
Parameter	Type	Description
severity	String	Definition Risk level. Range Length: 0 to 32 characters
image_num	Integer	Definition Number of images 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,
    "deduct_score" : 0,
    "policy_list" : [ {
      "policy_id" : "xxxx",
      "policy_name" : "xxxx",
      "os_type" : "xxxx",
      "host_num" : 1,
      "rule_name" : "xxxx"
    } ],
    "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" : [ {
      "policy_id" : "xxx",
      "policy_name" : "xxx",
      "os_type" : "xxx",
      "host_num" : 1,
      "rule_name" : "xxx"
    } ],
    "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" : [ {
      "policy_id" : "xxx",
      "policy_name" : "xxx",
      "os_type" : "xxx",
      "host_num" : 1,
      "rule_name" : "xxx"
    } ],
    "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
  },
  "security_protect_risk" : {
    "un_open_protection_host_num" : 118,
    "deduct_score" : 10,
    "total_risk_num" : 118
  },
  "total_risk_num" : 10663
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Dashboard

Previous topic: Querying Risk Score

Next topic: Security Reports

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot