Queries the details about vulnerabilities by group.

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 DescribeGroupedVul

The operation that you want to perform. Set the value to DescribeGroupedVul.

Lang String No zh

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese
  • en: English
Type String No cve

The type of the vulnerability that you want to query. Valid values:

  • cve: Linux software vulnerabilities
  • sys: Windows system vulnerabilities
  • cms: Web-CMS vulnerabilities
  • app: application vulnerabilities
  • emg: urgent vulnerabilities
  • sca: vulnerabilities that are detected based on software component analysis
Uuids String No d42f938c-d962-48a0-90f9-05e4ea****

The UUID of the server. Separate multiple UUIDs with commas (,).

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

The alias of the vulnerability that you want to query.

Necessity String No asap,later,nntf

The priority to fix the vulnerability that you want to query. Separate multiple priorities with commas (,). Valid values:

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

Specifies whether the vulnerability is handled. Valid values:

y: yes

n: no

CurrentPage Integer No 1

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

PageSize Integer No 20

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

GroupId String No 235454

The ID of the asset group.

SearchTags String No Restart required

The tag that is used to search for the vulnerability. Valid values:

  • Restart required
  • Remote exploitation
  • Exploit exists
  • Exploitable
  • Privilege escalation
  • Code execution

Response parameters

Parameter Type Example Description
CurrentPage Integer 1

The page number of the returned page.

RequestId String 9BFA6D78-07EA-5C0A-9358-E4434573507B

The ID of the request, which is used to locate and troubleshoot issues.

PageSize Integer 20

The number of entries returned per page. Default value: 10.

TotalCount Integer 1

The total number of returned entries.

GroupedVulItems Array of GroupedVulItem

An array that consists of the details about the vulnerability.

Type String cve

The type of the vulnerability. Valid values:

  • cve: Linux software vulnerabilities
  • sys: Windows system vulnerabilities
  • cms: Web-CMS vulnerabilities
  • app: application vulnerabilities
  • emg: urgent vulnerabilities
NntfCount Integer 59

The number of vulnerabilities that have the low priority.

HandledCount Integer 0

The number of handled vulnerabilities.

GmtLast Long 1639371446000

The timestamp when the vulnerability was last detected. Unit: milliseconds.

Tags String Restart required

The tag of the vulnerability. Valid values:

  • Restart required
  • Remote exploitation
  • Exploit exists
  • Exploitable
  • Privilege escalation
  • Code execution
LaterCount Integer 0

The number of vulnerabilities that have the medium priority.

AliasName String RHSA-2017:0184-Important: mysql security update

The alias of the vulnerability.

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

The name of the vulnerability.

TotalFixCount Long 0

The total number of fixed vulnerabilities.

AsapCount Integer 0

The number of vulnerabilities that have the high priority.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeGroupedVul
&Lang=zh
&Type=cve
&AliasName=RHSA-2019:0230-Important: polkit security update
&Necessity=asap,later,nntf
&Dealed=n
&CurrentPage=1
&PageSize=20
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<TotalCount>2</TotalCount>
<PageSize>20</PageSize>
<RequestId>0DFCADBA-7065-42DA-AF17-6868B9C2A8CF</RequestId>
<CurrentPage>1</CurrentPage>
<GroupedVulItems>
    <Type>cve</Type>
    <LaterCount>0</LaterCount>
    <GmtLast>1554185744000</GmtLast>
    <HandledCount>0</HandledCount>
    <AliasName>RHSA-2019:0230-Important: polkit security update</AliasName>
    <AsapCount>0</AsapCount>
    <TotalFixCount>0</TotalFixCount>
    <NntfCount>59</NntfCount>
    <Tags>Restart required</Tags>
    <Name>***glibc security and bug fixes</Name>
</GroupedVulItems>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : "2",
  "PageSize" : "20",
  "RequestId" : "0DFCADBA-7065-42DA-AF17-6868B9C2A8CF",
  "CurrentPage" : "1",
  "GroupedVulItems" : [ {
    "Type" : "cve",
    "LaterCount" : "0",
    "GmtLast" : "1554185744000",
    "HandledCount" : "0",
    "AliasName" : "RHSA-2019:0230-Important: polkit security update",
    "AsapCount" : "0",
    "TotalFixCount" : "0",
    "NntfCount" : "59",
    "Tags" : "Restart required",
    "Name" : "***glibc security and bug fixes"
  } ]
}

Error codes

HTTP status code Error code Error message Description
400 NoPermission no permission The error message returned because you do not have access permissions.
500 ServerError ServerError The error message returned because a server error occurred.

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