Queries vulnerabilities by type.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeVulList

The operation that you want to perform.

Set the value to DescribeVulList.

Type String Yes cve

The type of the vulnerability. Valid values:

  • cve: Linux software vulnerabilities
  • sys: Windows vulnerabilities
  • cms: Web CMS vulnerabilities
  • app: application vulnerabilities
  • emg: emergency vulnerabilities
Lang String No zh

The natural language of the request and response. Valid values:

  • zh: Chinese
  • en: English
Remark String No 1.2.3.4

The tags to query, including the internal IP address, public IP address, and name of the asset.

Uuids String No 1587bedb-fdb4-48c4-9330-************

The unique ID of the asset. Separate multiple IDs with commas (,).

AliasName String No RHSA-2019:0230-Important: polkit security update

The alias of the vulnerability.

Necessity String No asap,later,nntf

The priority to fix vulnerabilities. Separate multiple priorities with commas (,). Valid values:

  • asap: high
  • later: medium
  • nntf: low
Dealed String No n

Specifies whether the vulnerability has been handled. Valid values:

  • y: handled
  • n: unhandled
CurrentPage Integer No 1

The number of the page to return. Pages start from page 1. Default value: 1.

PageSize Integer No 20

The number of entries to return on each page. Default value: 20.

Response parameters

Parameter Type Example Description
RequestId String ECDE6715-6286-40E6-A32D-3094051FD74D

The ID of the request.

CurrentPage Integer 1

The page number of the returned page.

PageSize Integer 20

The number of entries returned per page.

TotalCount Integer 2

The total number of entries returned.

VulRecords Array

The vulnerability information.

AliasName String RHSA-2017:0574: gnutls security, bug fix, and enhancement update

The alias of the vulnerability.

ExtendContentJson Struct

The extended information.

AbsolutePath String /roo/www/web

The package path of the software that is detected with the vulnerabilities.

AliasName String RHSA-2017:0574: gnutls security, bug fix, and enhancement update

The alias of the vulnerability.

Ip String 1.2.3.1

The public IP address of the asset that is associated with the vulnerability.

LastTs Long 1554189334000

The last time when the vulnerability was detected.

Necessity Struct

The priority to fix vulnerabilities.

Assets_factor String 1

The asset score.

Cvss_factor String 7.8

The Common Vulnerability Scoring System (CVSS) score.

Enviroment_factor String 1.0

The environmental score.

Gmt_create String 20190331

The creation time.

Is_calc String 1

Indicates whether the vulnerability severity score is calculated. Valid values:

  • 0: The score is not calculated.
  • 1: The score is calculated.
Status String normal

The status of the vulnerability severity score. Valid values:

  • none: No score is generated.
  • pending: The score is pending calculation.
  • miss: The score failed to be calculated.
  • normal: The calculation is normal.
Time_factor String 1.0

The temporal score.

Total_score String 7.8

The total vulnerability severity score. We recommend that you apply the following rules:

  • Critical: The severity score is between 13.5 and 15, which typically represents a high-risk vulnerability.
  • Important: The severity score is between 7.1 and 13.5, which typically represents a medium-risk vulnerability.
  • Moderate: The severity score is below 7, which typically represents a low-risk vulnerability.
Os String centos

The operating system.

OsRelease String 7

The version of the operation system.

PrimaryId Long 111

The ID of the vulnerability.

RpmEntityList Array

The RPM package list.

FullVersion String 3.10.0-693.2.2.el7

The full version number.

MatchDetail String python-perf version less than 0:3.10.0-693.21.1.el7

The detailed matching information of the vulnerability.

Name String python-perf

The name of the RPM package.

Path String /usr/lib64/python2.7/site-packages

The path of the software that is detected with the vulnerabilities.

UpdateCmd String *** update python-perf

The fix command.

Version String 3.10.0

The version number.

Status Integer 1

The status of the vulnerability. Valid values:

  • 1: unfixed
  • 2: fix failed
  • 3: rollback failed
  • 4: fixing
  • 5: rolling back
  • 6: verifying
  • 7: fixed
  • 8: fixed and to be restarted
  • 9: rolled back
  • 10: ignored
  • 11: rolled back and to be restarted
  • 12: not found
  • 20: expired
Tag String oval

The tag of the vulnerability.

cveList List ["CVE-2016-8610", "CVE-2017-5335" ]

The Common Vulnerabilities and Exposures (CVE) list.

FirstTs Long 1554189334000

The first time when the vulnerability was detected. Unit: milliseconds.

GroupId Integer 281801

The ID of the asset group.

InstanceId String i-bp18t***

The instance ID of the asset.

InstanceName String Test ECS

The instance name of the asset.

InternetIp String 1.2.3.1

The public IP address of the asset.

IntranetIp String 1.2.3.4

The internal IP address of the asset.

LastTs Long 1541207563000

The last time when the vulnerability was detected. This value is a timestamp.

ModifyTs Long 1541207563000

The time when the vulnerability was modified. This value is a timestamp.

Name String oval:com.redhat.rhsa:def:20170574

The name of the vulnerability.

Necessity String asap

The priority to fix vulnerabilities. Valid values:

  • asap: high
  • later: medium
  • nntf: low
Note We recommend that you fix the high level of vulnerabilities as soon as possible.
Online Boolean true

Indicates whether the asset instance is online. Valid values:

  • true: online
  • false: offline
OsVersion String linux

The version of the operating system.

PrimaryId Long 101162078

The ID of the vulnerability.

Related String CVE-2017-7518,CVE-2017-12188

The list of CVEs related to the vulnerability. Separate multiple CVE entries with commas (,).

RepairTs Long 1541207563000

The time when the vulnerability was fixed. This value is a timestamp.

ResultCode String 0

The result code returned after the vulnerability is fixed.

ResultMessage String timeout

The message returned after the vulnerability is fixed.

Status Integer 1

The status of the vulnerability. Valid values:

  • 1: unfixed
  • 2: fix failed
  • 3: rollback failed
  • 4: fixing
  • 5: rolling back
  • 6: verifying
  • 7: fixed
  • 8: fixed and to be restarted
  • 9: rolled back
  • 10: ignored
  • 11: rolled back and to be restarted
  • 12: not found
  • 20: expired
Tag String oval

The tag of the vulnerability.

Type String cve

The type of the vulnerability. Valid values:

  • cve: Linux vulnerabilities
  • sys: Windows vulnerabilities
  • cms: Web CMS vulnerabilities
  • emg: emergency vulnerabilities
  • app: application vulnerabilities
Uuid String 04c56617-23fc-43a5-ab9b-************

The ID of the asset. Asset IDs are unique.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeVulList
&Type=cve
&<Common request parameters>

Sample success responses

XML format

<DescribeVulListResponse>
      <TotalCount>2</TotalCount>
      <RequestId>ECDE6715-6286-40E6-A32D-3094051FD74D</RequestId>
      <PageSize>20</PageSize>
      <VulRecords>
            <Status>1</Status>
            <InstanceId>i-bp18t***</InstanceId>
            <OsVersion>linux</OsVersion>
            <LastTs>1541207563000</LastTs>
            <Necessity>asap</Necessity>
            <ResultMessage>timeout</ResultMessage>
            <IntranetIp>1.2.3.4</IntranetIp>
            <Name>oval:com.redhat.rhsa:def:20170574</Name>
            <GroupId>281801</GroupId>
            <RepairTs>1541207563000</RepairTs>
            <InstanceName>Test ECS</InstanceName>
            <Type>cve</Type>
            <FirstTs>1554189334000</FirstTs>
            <Uuid>04c56617-23fc-43a5-ab9b-************</Uuid>
            <Related>CVE-2017-7518,CVE-2017-12188</Related>
            <ModifyTs>1541207563000</ModifyTs>
            <InternetIp>1.2.3.1</InternetIp>
            <AliasName>RHSA-2017:0574: gnutls security, bug fix, and enhancement update</AliasName>
            <Tag>oval</Tag>
            <Online>true</Online>
            <PrimaryId>101162078</PrimaryId>
            <ResultCode>0</ResultCode>
      </VulRecords>
      <VulRecords>
            <ExtendContentJson>
                  <Status>1</Status>
                  <Os>centos</Os>
                  <AliasName>RHSA-2017:0574: gnutls security, bug fix, and enhancement update</AliasName>
                  <Ip>1.2.3.1</Ip>
                  <LastTs>1554189334000</LastTs>
                  <cveList>["CVE-2016-8610", "CVE-2017-5335" ]</cveList>
                  <Necessity>
                        <Status>normal</Status>
                        <Total_score>7.8</Total_score>
                        <Gmt_create>20190331</Gmt_create>
                        <Cvss_factor>7.8</Cvss_factor>
                        <Time_factor>1.0</Time_factor>
                        <Is_calc>1</Is_calc>
                        <Enviroment_factor>1.0</Enviroment_factor>
                        <Assets_factor>1</Assets_factor>
                  </Necessity>
                  <RpmEntityList>
                        <Path>/usr/lib64/python2.7/site-packages</Path>
                        <UpdateCmd>*** update python-perf</UpdateCmd>
                        <Version>3.10.0</Version>
                        <FullVersion>3.10.0-693.2.2.el7</FullVersion>
                        <MatchDetail>python-perf version less than 0:3.10.0-693.21.1.el7</MatchDetail>
                        <Name>python-perf</Name>
                  </RpmEntityList>
                  <Tag>oval</Tag>
                  <OsRelease>7</OsRelease>
                  <AbsolutePath>/roo/www/web</AbsolutePath>
                  <PrimaryId>111</PrimaryId>
            </ExtendContentJson>
      </VulRecords>
      <CurrentPage>1</CurrentPage>
</DescribeVulListResponse>

JSON format

{
		"TotalCount": "2",
		"RequestId": "ECDE6715-6286-40E6-A32D-3094051FD74D",
		"PageSize": "20",
		"VulRecords": [{
			"Status": "1",
			"InstanceId": "i-bp18t***",
			"OsVersion": "linux",
			"LastTs": "1541207563000",
			"Necessity": "asap",
			"ResultMessage": "timeout",
			"IntranetIp": "1.2.3.4",
			"Name": "oval:com.redhat.rhsa:def:20170574",
			"GroupId": "281801",
			"RepairTs": "1541207563000",
			"InstanceName": "Test ECS",
			"Type": "cve",
			"FirstTs": "1554189334000",
			"Uuid": "04c56617-23fc-43a5-ab9b-************",
			"Related": "CVE-2017-7518,CVE-2017-12188",
			"ModifyTs": "1541207563000",
			"InternetIp": "1.2.3.1",
			"AliasName": "RHSA-2017:0574: gnutls security, bug fix, and enhancement update",
			"Tag": "oval",
			"Online": "true",
			"PrimaryId": "101162078",
			"ResultCode": "0"
		}, {
			"ExtendContentJson": {
				"Status": "1",
				"Os": "centos",
				"AliasName": "RHSA-2017:0574: gnutls security, bug fix, and enhancement update",
				"Ip": "1.2.3.1",
				"LastTs": "1554189334000",
				"cveList": "[\"CVE-2016-8610\", \"CVE-2017-5335\" ]",
				"Necessity": {
					"Status": "normal",
					"Total_score": "7.8",
					"Gmt_create": "20190331",
					"Cvss_factor": "7.8",
					"Time_factor": "1.0",
					"Is_calc": "1",
					"Enviroment_factor": "1.0",
					"Assets_factor": "1"
				},
				"RpmEntityList": [{
					"Path": "/usr/lib64/python2.7/site-packages",
					"UpdateCmd": "*** update python-perf",
					"Version": "3.10.0",
					"FullVersion": "3.10.0-693.2.2.el7",
					"MatchDetail": "python-perf version less than 0:3.10.0-693.21.1.el7",
					"Name": "python-perf"
				}],
				"Tag": "oval",
				"OsRelease": "7",
				"AbsolutePath": "/roo/www/web",
				"PrimaryId": "111"
			}
		}],
		"CurrentPage": "1"
}

Error code

For a list of error codes, visit the API Error Center.