Monitoring Emergency Vulnerabilities
Function
This API is used to query the emergency vulnerability 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}/vulnerability/urgent-vulnerabilities
|
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. |
|
offset |
No |
Integer |
Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0. |
|
limit |
No |
Integer |
Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10 |
|
severity_level |
No |
String |
Definition Severity. Constraints N/A Range
Default Value N/A |
|
handle_status |
No |
String |
Definition Handling status. Constraints N/A Range Default Value N/A |
|
vul_name |
No |
String |
Definition Vulnerability name. Range Length: 0 to 256 characters |
|
is_container |
No |
Boolean |
Definition Whether it is the container scenario. Constraints N/A Range Default Value N/A |
|
cluster_id |
No |
String |
Definition Cluster ID. Range The value can contain 0 to 256 characters. |
|
min_scan_time |
No |
Long |
Definition Minimum start time of a scan task. Range The value can contain 0 to 9223372036854775807 characters. |
|
max_scan_time |
No |
Long |
Definition Maximum start time of a scan task. Range The value can contain 0 to 9223372036854775807 characters. |
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 |
|---|---|---|
|
total_num |
Long |
Definition Total number. Range 0 to 2147483647 characters |
|
data_list |
Array of UrgentVulInfo objects |
Definition Emergency vulnerability list. |
|
Parameter |
Type |
Description |
|---|---|---|
|
vul_name |
String |
Definition Vulnerability name. Range Length: 0 to 256 characters |
|
vul_id |
String |
Definition Vulnerability ID. Range The value can contain 0 to 64 characters. |
|
label_list |
Array of strings |
Definition Vulnerability tag. Range The value range is 0 to 2,147,483,647. |
|
hosts_num |
VulnerabilityHostNumberInfo object |
Definition Number of affected servers. |
|
scan_time |
Long |
Definition Last scan time. Range The value can contain 0 to 9223372036854775807 characters. |
|
publish_time |
Long |
Definition Vulnerability disclosure time. Range The value can contain 0 to 9223372036854775807 characters. |
|
solution_detail |
String |
Definition Solution Range The value can contain 0 to 65,534 characters. |
|
description |
String |
Definition Vulnerability description. Range The value can contain 0 to 64 characters. |
|
scan_status |
String |
Definition Vulnerability scan status. Constraints N/A Range Default Value N/A |
|
severity_level |
String |
Definition Severity. Constraints N/A Range
Default Value N/A |
|
scanning_host_num |
Integer |
Definition Number of servers being scanned. Range 0 to 2147483647 characters |
|
success_host_num |
Integer |
Definition Number of servers that have been scanned. Range 0 to 2147483647 characters |
|
failed_host_num |
Integer |
Definition Number of servers that fail to be scanned. Range 0 to 2147483647 characters |
|
Parameter |
Type |
Description |
|---|---|---|
|
important |
Integer |
Definition Number of important servers. Range The value range is 0 to 10,000. |
|
common |
Integer |
Definition Number of common servers. Range The value range is 0 to 10,000. |
|
test |
Integer |
Definition Number of test servers. Range The value range is 0 to 10,000. |
Example Requests
Querying the Emergency Vulnerability List
GET https://{endpoint}/v5/{project_id}/vulnerability/urgent-vulnerabilities?offset=0&limit=200&enterprise_project_id=all_granted_eps
Example Responses
None
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