DescribeVulList

Description

Call the DescribeVulList interface to query vulnerability information, that is, query the corresponding vulnerability information according to the vulnerability type.

Request Method

POST

Request Path

/apsara/route/aegis/DescribeVulList

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
Type	BODY	string	Yes	cve	vulnerability type. Valid values include: cve:Linux software vulnerability sys:Windows system vulnerability cms:Web-CMS vulnerability app: application vulnerability emg: emergency vulnerability
PageSize	BODY	integer	No	20	The maximum number of pieces of data displayed per page when missing a paged query. The default value is 20.
CurrentPage	BODY	integer	No	1	the page number of the current page displayed when paging query. The starting value is 1 and the default value is 1.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
AliasName	BODY	string	No	RHSA-2019:0230-Important: polkit security update	vulnerability alias.
Necessity	BODY	string	No	asap,later,nntf	vulnerability repair necessity level. Multiple levels are separated by English commas. Valid values include: asap: high later: medium nntf: low
Lang	BODY	string	No	zh	the language type of the request and receive message. Valid values include: zh: Chinese en: English
Uuids	BODY	string	No	1587bedb-fdb4-48c4-9330-************	unique ID list of asset instances, multiple IDs separated by English commas.
Dealed	BODY	string	No	n	whether the vulnerability has been processed. Valid values include: y: processed n: Unprocessed
version	BODY	string	No	2016-01-01	version of api
Remark	BODY	string	No	1.2.3.4	query mark, which can be the asset intranet IP, extranet IP or asset name.

Return data

Name	Type	Sample value	Description
Total_score	string	No sample value for this parameter.	total score of vulnerability impact. According to the vulnerability score, the following repair suggestions are provided: need to be fixed as soon as possible: the vulnerability fix urgency score is between 13.5~15 (usually high-risk vulnerabilities). can be repaired later: the vulnerability fix urgency score is between 7.1~13.5 (usually medium-risk vulnerabilities). can not be fixed for the time being: the vulnerability fix urgency score is 7 below (usually low-risk vulnerabilities).
PageSize	integer	No sample value for this parameter.	The maximum number of pieces of data displayed per page when querying by page.
Cvss_factor	string	No sample value for this parameter.	CVSS factor.
Time_factor	string	No sample value for this parameter.	time factor.
Ip	string	No sample value for this parameter.	the public IP address of the assets associated with the vulnerability.
OsVersion	string	No sample value for this parameter.	operating system version.
cveList	list	No sample value for this parameter.	vulnerability announcement list.
Enviroment_factor	string	No sample value for this parameter.	environment factor.
FullVersion	string	No sample value for this parameter.	full version number.
IntranetIp	string	No sample value for this parameter.	asset intranet IP.
Name	string	No sample value for this parameter.	vulnerability name.
RepairTs	long	No sample value for this parameter.	repair time, timestamp.
UpdateCmd	string	No sample value for this parameter.	fix command.
ModifyTs	long	No sample value for this parameter.	modify time, timestamp.
InternetIp	string	No sample value for this parameter.	asset external network IP.
Version	string	No sample value for this parameter.	version number.
AliasName	string	No sample value for this parameter.	vulnerability alias.
OsRelease	string	No sample value for this parameter.	operating system description.
ExtendContentJson	struct	No sample value for this parameter.	extended information.
MatchDetail	string	No sample value for this parameter.	vulnerability hit details.
Assets_factor	string	No sample value for this parameter.	asset factor.
Status	integer	No sample value for this parameter.	vulnerability status. Valid values include: 1: not fixed 2: repair failed 3: rollback failed 4: repairing 5: rollback 6: verification 7: repair succeeded 8: the repair was successful to be restarted 9: rollback successful 10: ignored 11: rollback successfully pending restart 12: the vulnerability does not exist 20: expired
Path	string	No sample value for this parameter.	the path of the software with the vulnerability.
RequestId	string	No sample value for this parameter.	the unique identifier generated by alibaba cloud for this request.
VulRecords	array	No sample value for this parameter.	vulnerability information.
OS	string	No sample value for this parameter.	operating system.
InstanceId	string	No sample value for this parameter.	asset instance ID.
Is_calc	string	No sample value for this parameter.	Whether the score has been calculated. Value: 0: not calculated 1: Calculated
LastTs	long	No sample value for this parameter.	Last discovery time, timestamp.
Necessity	string	No sample value for this parameter.	vulnerability repair necessity level. Valid values include: asap: high later: medium nntf: low description it is recommended that you fix the vulnerability with necessity level high as soon as possible.
RpmEntityList	array	No sample value for this parameter.	RPM package list.
AbsolutePath	string	No sample value for this parameter.	affects the path of the package.
ResultMessage	string	No sample value for this parameter.	fix the return message.
GroupId	integer	No sample value for this parameter.	asset group ID.
InstanceName	string	No sample value for this parameter.	asset instance name.
TotalCount	integer	No sample value for this parameter.	the total number of query results.
Gmt_create	string	No sample value for this parameter.	creation time.
FirstTs	long	No sample value for this parameter.	the number of milliseconds of the first discovery time.
Type	string	No sample value for this parameter.	vulnerability type. Valid values include: cve:Linux vulnerability sys:Windows vulnerability cms:WebCMS vulnerability emg: emergency vulnerability app: application vulnerability
Related	string	No sample value for this parameter.	vulnerability association CVE list, with multiple values separated by English commas (,).
Uuid	string	No sample value for this parameter.	unique identification ID of the asset instance.
CurrentPage	integer	No sample value for this parameter.	the page number of the current page displayed during paging query.
Tag	string	No sample value for this parameter.	vulnerability tag.
Online	boolean	No sample value for this parameter.	Whether the asset instance is online. Valid values include: true: online false: offline
PrimaryId	long	No sample value for this parameter.	vulnerability ID.
ResultCode	string	No sample value for this parameter.	fix the return code.

Example

Successful Response example

"The successful response sample is not recognizable. Please modify API definition in API gateway before re-create the API document."

Failed Response example

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

}

---

title: DescribeVulWhitelist

sidebar_position: 3

DescribeVulWhitelist

Description

call DescribeVulWhitelist interface paging query vulnerability whitelist.

Request Method

POST

Request Path

/apsara/route/aegis/DescribeVulWhitelist

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
PageSize	BODY	integer	No	10	When paging query, the number of data is displayed on each page. The default value is 20.
CurrentPage	BODY	integer	No	1	page number when paging query. The starting value is 1 and the default value is 1.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
version	BODY	string	No	2016-01-01	version of api

Return data

Name	Type	Sample value	Description
TotalCount	integer	1	total data.
Type	string	cve	vulnerability type.
PageSize	integer	10	when paging query, the current page displays the number of data.
RequestId	string	74F97EF7-B543-43FD-A4E9-18456731F9C5	request ID of the result.
VulWhitelists	array	No sample value for this parameter.	vulnerability whitelist information.
CurrentPage	integer	1	page number of the current page when paging query.
AliasName	string	RHSA-2017:3263: curl security update	vulnerability alias.
Reason	string	No repair yet	whiten the reason.
Name	string	oval:com.redhat.rhsa:def:20173263	vulnerability name.

Example

Successful Response example

{
 "TotalCount":"1",
 "Type":"cve",
 "PageSize":"10",
 "RequestId":"74F97EF7-B543-43FD-A4E9-18456731F9C5",
 "VulWhitelists":"",
 "CurrentPage":"1",
 "AliasName":"RHSA-2017:3263: curl security update",
 "Reason":"No repair yet",
 "Name":"oval:com.redhat.rhsa:def:20173263"
}

Failed Response example

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

}

---

title: DescribeWarningMachines

sidebar_position: 3

DescribeWarningMachines

Description

call the DescribeWarningMachines interface to query the information of the server that performed the baseline check, including the server ID, detected risk item statistics, risk item status and other information.

Request Method

POST

Request Path

/apsara/route/Sas/DescribeWarningMachines

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
RiskId	BODY	long	Yes	1	risk item ID. description queries the information of the server that has performed the baseline check. you need to provide the risk item ID of the baseline check, which can be obtained by the DescribeCheckWarningSummary interface.
SourceIp	BODY	string	No	1.2.3.4	access source IP address.
MachineName	BODY	string	No	baseline test server	the name of the server performing the baseline check.
PageSize	BODY	integer	No	10	The maximum number of pieces of data per page displayed during a paged query.
CurrentPage	BODY	integer	No	1	the page number of the current page displayed when paging query.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
StrategyId	BODY	long	No	1	ID of the baseline check policy.
Lang	BODY	string	No	zh	the language type of the request and receive message. Value: zh: Chinese en: English
Uuids	BODY	string	No	xxx-aaa-bbb-ccc	server id that performs baseline check. Multiple IDs are separated by English commas (,).
version	BODY	string	No	2016-01-01	version of api

Return data

Name	Type	Sample value	Description
Status	integer	1	check the status of risk item verification after the baseline item repair is completed. Value: 1: completed 2: verification
PageSize	integer	10	The maximum number of pieces of data displayed per page when querying by page.
RequestId	string	00BDE2-284A-4534-BD09-FB69836DD750	the unique identifier generated by alibaba cloud for this request.
InstanceId	string	i-m5ee8b9nr3h30mhb****	the instance ID of the server.
Count	integer	10	the number of data on the current page displayed when querying by paging.
IntranetIp	string	1.2.3.5	server intranet IP.
LowWarningCount	integer	3	the number of low-risk check items.
InstanceName	string	aaawebtest	instance name.
MediumWarningCount	integer	2	The number of dangerous check items.
TotalCount	integer	100	the total number of data.
Uuid	string	xxx-aaa-bbb-ccc	ID of the server performing the baseline check.
InternetIp	string	1.2.3.4	server external network IP.
CurrentPage	integer	1	the page number of the current page displayed during paging query.
WarningMachines	array	No sample value for this parameter.	information about the server that generated the alarm.
HighWarningCount	integer	10	the number of high-risk check items.
RegionId	string	cn-qingdao	the region ID of the server.
PassCount	integer	10	the number of check items that passed the detection.

Example

Successful Response example

{
 "Status":"1",
 "PageSize":"10",
 "RequestId":"00BDE2-284A-4534-BD09-FB69836DD750",
 "InstanceId":"i-m5ee8b9nr3h30mhb****",
 "Count":"10",
 "IntranetIp":"1.2.3.5",
 "LowWarningCount":"3",
 "InstanceName":"aaawebtest",
 "MediumWarningCount":"2",
 "TotalCount":"100",
 "Uuid":"xxx-aaa-bbb-ccc",
 "InternetIp":"1.2.3.4",
 "CurrentPage":"1",
 "WarningMachines":"",
 "HighWarningCount":"10",
 "RegionId":"cn-qingdao",
 "PassCount":"10"
}

Failed Response example

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

}