Skip to main content

DescribeGroupedVul

Description

Get the information of the specified vulnerability group. Vulnerability management supports displaying detected vulnerability records in the form of vulnerability groups, which contain all host assets detected by Server Guard.

Request Method

POST

Request Path

/apsara/route/Sas/DescribeGroupedVul

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
OrderByBODYstringNoNo sample value for this parameter.sort fields, which can be sorted by specifying other request parameter fields.
LastTsStartBODYlongNoNo sample value for this parameter.the detection start time of the last detection discovery time of the vulnerability.
PageSizeBODYintegerNoNo sample value for this parameter.specifies the maximum number of records per page in the returned result. default value: 20
StatusListBODYstringNoNo sample value for this parameter.vulnerability status, value range: 1: indicates not repaired 2: indicates that the repair failed 3: indicates rollback failure 4: indicates that it is being repaired 5: means rollback 6: indicates that verification is in process 7: indicates that the repair was successful 8: indicates that the repair is successful and needs to be restarted 9: indicates successful rollback 10: indicates that it has been ignored 11: indicates a successful rollback to be restarted 12: indicates that the vulnerability no longer exists 20: indicates that the vulnerability has expired Description Separate multiple states.
NecessityBODYstringNoNo sample value for this parameter.Vulnerability repair necessity, value range: asap: indicates that it needs to be repaired as soon as possible later: indicates that the repair can be delayed nntf: indicates that it can not be repaired for the time being
ProductBODYstringNoNo sample value for this parameter.the product corresponding to the vulnerability.
PatchIdBODYlongNoNo sample value for this parameter.the patch ID corresponding to the vulnerability.
DealedBODYstringNoNo sample value for this parameter.whether the vulnerability has been processed. Y: indicates processed N: indicates unprocessed
DirectionBODYstringNoNo sample value for this parameter.Vulnerability grouping sorting method, value range: asc: indicates sequential arrangement desc: indicates reverse order
versionBODYstringNo2016-01-01version of api
NameBODYstringNoNo sample value for this parameter.vulnerability name.
LastTsEndBODYlongNoNo sample value for this parameter.the detection end time of the last detection discovery time of the vulnerability.
TypeBODYstringNoNo sample value for this parameter.vulnerability type.
CurrentPageBODYintegerNoNo sample value for this parameter.specifies the number of pages currently returned. default value: 1
regionIdBODYstringYesNo sample value for this parameter.region id
LevelBODYstringNoNo sample value for this parameter.vulnerability level, value range: serious: indicates serious high: indicates high risk medium: indicates medium risk low: indicates low risk
UuidsBODYstringNoNo sample value for this parameter.host asset UUID, specifying multiple host asset UUIDs separated.

Return data

NameTypeSample valueDescription
PendingCountintegerno demo valuenumber of unhandled vulnerabilities.
RequestIdstringno demo valuerequest ID.
PageSizeintegerno demo valuepage displays the maximum number of records.
GmtLastlongno demo valuethe last discovery time of the vulnerability.
Stautsintegerno demo valuevulnerability status.
AsapCountintegerno demo valuethe number of assets that need to be repaired as soon as possible.
Productstringno demo valueproducts affected by the vulnerability.
Countintegerno demo valuetotal number of vulnerabilities.
Namestringno demo valuevulnerability name.
TotalCountintegerno demo valuetotal number of vulnerabilities.
Typestringno demo valuevulnerability type.
CurrentPageintegerno demo valuecurrently returns page number.
HandledCountintegerno demo valuenumber of handled vulnerabilities.
GroupedVulItemsarrayno demo valuevulnerability grouping information, see the following parameter description for specific sub-items.
AliasNamestringno demo valuevulnerability alias.
Levelstringno demo valuevulnerability level.

Example

Successful Response example

{
"PendingCount":"no demo value",
"RequestId":"no demo value",
"PageSize":"no demo value",
"GmtLast":"no demo value",
"Stauts":"no demo value",
"AsapCount":"no demo value",
"Product":"no demo value",
"Count":"no demo value",
"Name":"no demo value",
"TotalCount":"no demo value",
"Type":"no demo value",
"CurrentPage":"no demo value",
"HandledCount":"no demo value",
"GroupedVulItems":"no demo value",
"AliasName":"no demo value",
"Level":"no demo value"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}