Skip to main content

DescribeVulList

Description

get the vulnerability list of the specified host asset.

Request Method

POST

Request Path

/apsara/route/Sas/DescribeVulList

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
TypeBODYstringNoNo sample value for this parameter.vulnerability type.
PageSizeBODYintegerNoNo sample value for this parameter.specifies the maximum number of records per page in the returned result. default value: 20
CurrentPageBODYintegerNoNo sample value for this parameter.specifies the number of pages currently returned. default value: 1
regionIdBODYstringYesNo sample value for this parameter.region id
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 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
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.
DealedBODYstringNoNo sample value for this parameter.whether the vulnerability has been processed. Y: indicates processed N: indicates unprocessed
versionBODYstringNo2016-01-01version of api
NameBODYstringNoNo sample value for this parameter.vulnerability name.

Return data

NameTypeSample valueDescription
PageSizeintegerno demo valuepage displays the maximum number of records.
Productstringno demo valueproducts affected by the vulnerability.
Namestringno demo valuevulnerability name.
RepairTslongno demo valuethe time when the vulnerability was fixed.
ModifyTslongno demo valuevulnerability record last update time.
AliasNamestringno demo valuevulnerability alias.
RecordIdlongno demo valuevulnerability record ID.
ExtendContentJsonstringno demo valuevulnerability related extension information (JSON format).
Statusintegerno demo valuevulnerability status: 1: indicates pending processing 2: indicates that it has been ignored 3: indicates confirmed 8: indicates that it has been marked as a false positive 16: indicates that processing 32: indicates that the processing is complete
ExtendContentstringno demo valuevulnerability related extension information.
RequestIdstringno demo valuerequest ID.
VulRecordsarrayno demo valuevulnerability record list, see the following parameter description for specific sub-items.
LastTslongno demo valuethe last discovery time of the vulnerability record.
Necessitystringno demo valueVulnerability repair necessity: 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
ResultMessagestringno demo valuevulnerability handling operation result information.
RiskDescstringno demo valuevulnerability risk description.
TotalCountintegerno demo valuereturns the total number of records.
FirstTslongno demo valuevulnerability record first discovery time.
Typestringno demo valuevulnerability type.
Relatedstringno demo valueCVE ID associated with the vulnerability.
Uuidstringno demo valuehost asset UUID.
CurrentPageintegerno demo valuecurrently returns page number.
Levelstringno demo valuevulnerability level.
Tagstringno demo valuevulnerability tag information.
RiskLevelintegerno demo valuevulnerability risk level.
PrimaryIdlongno demo valueprimary key ID.
ResultCodestringno demo valuevulnerability handling operation result encoding.

Example

Successful Response example

{
"PageSize":"no demo value",
"Product":"no demo value",
"Name":"no demo value",
"RepairTs":"no demo value",
"ModifyTs":"no demo value",
"AliasName":"no demo value",
"RecordId":"no demo value",
"ExtendContentJson":"no demo value",
"Status":"no demo value",
"ExtendContent":"no demo value",
"RequestId":"no demo value",
"VulRecords":"no demo value",
"LastTs":"no demo value",
"Necessity":"no demo value",
"ResultMessage":"no demo value",
"RiskDesc":"no demo value",
"TotalCount":"no demo value",
"FirstTs":"no demo value",
"Type":"no demo value",
"Related":"no demo value",
"Uuid":"no demo value",
"CurrentPage":"no demo value",
"Level":"no demo value",
"Tag":"no demo value",
"RiskLevel":"no demo value",
"PrimaryId":"no demo value",
"ResultCode":"no demo value"
}

Failed Response example

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

}