DescribeGroupedVul - Security Center - Alibaba Cloud Documentation Center

Queries vulnerabilities by group.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:DescribeGroupedVul	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese en: English	zh
Type	string	No	The type of the vulnerability that you want to query. Default value: cve. Valid values: cve: Linux software vulnerability sys: Windows system vulnerability cms: Web-CMS vulnerability app: application vulnerability that is detected by network scanning sca: application vulnerability that is detected by software component analysis	cve
Uuids	string	No	The UUID of the server. Separate multiple UUIDs with commas (,).	d42f938c-d962-48a0-90f9-05e4ea****
AliasName	string	No	The alias of the vulnerability.	RHSA-2019:0230-Important: polkit security update
Necessity	string	No	The priorities to fix the vulnerabilities. Separate multiple priorities with commas (,). Valid values: asap: high later: medium nntf: low	asap,later,nntf
Dealed	string	No	Specifies whether the vulnerability is handled. Valid values: y: handled n: not handled	n
CurrentPage	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10.	20
GroupId	string	No	The ID of the asset group.	235454
ContainerFieldName	string	No	The key of the condition that is used to query containers. Valid values: instanceId: the ID of the asset appName: the name of the application clusterId: the ID of the cluster regionId: the ID of the region nodeName: the name of the node namespace: the namespace clusterName: the name of the cluster image: the name of the image imageRepoName: the name of the image repository imageRepoNamespace: the namespace to which the image repository belongs imageRepoTag: the tag that is added to the image imageDigest: the digest of the image	appName
TargetType	string	No	The query type for containers. Valid values: containerId: the ID of the container uuid: the ID of the asset	containerId
SearchTags	string	No	The tag that is used to search for the vulnerability. Valid values: Restart required Remote utilization EXP exists Available Elevation of Privilege Code Execution	Code Execution
AttachTypes	string	No	The type of the vulnerability. This parameter is valid only for application vulnerabilities. Separate multiple values with commas (,). Valid values: sca: vulnerability that is detected based on software component analysis app: application vulnerability	sca
AssetType	string	No	The type of the asset on which the vulnerability is detected. Separate multiple types with commas (,). Valid values: ECS: Elastic Compute Service (ECS) instance CONTAINER: container	ECS,CONTAINER
ResourceDirectoryAccountId	long	No	The Alibaba Cloud account ID of the member in the resource directory. Note You can call the DescribeMonitorAccounts operation to query the account ID.	127608589417****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
CurrentPage	integer	The page number.	1
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	9BFA6D78-07EA-5C0A-9358-E4434573507B
PageSize	integer	The number of entries per page. Default value: 10.	20
TotalCount	integer	The total number of entries returned.	1
GroupedVulItems	array<object>	The information about the vulnerability.
GroupedVulItem	object
Type	string	The type of the vulnerability. Valid values: cve: Linux software vulnerability sys: Windows system vulnerability cms: Web-CMS vulnerability app: application vulnerability emg: urgent vulnerability sca: vulnerability that is detected by software component analysis	cve
NntfCount	integer	The number of vulnerabilities that have the low priority.	59
RaspDefend	integer	Indicates whether the application protection feature is supported. Valid values: 0: not supported 1: supported Note If this parameter is not returned, the application protection feature is not supported.	1
HandledCount	integer	The number of handled vulnerabilities.	0
GmtLast	long	The timestamp when the vulnerability was last detected. Unit: milliseconds.	1639371446000
Tags	string	The tag of the vulnerability. Valid values: Restart required Remote utilization EXP exists Available Elevation of Privilege Code Execution	Code Execution
LaterCount	integer	The number of vulnerabilities that have the medium priority.	0
AliasName	string	The alias of the vulnerability.	RHSA-2017:0184-Important: mysql security update
Name	string	The name of the vulnerability.	oval:com.redhat.rhsa:def:20170184
TotalFixCount	long	The total number of fixed vulnerabilities.	0
AsapCount	integer	The number of vulnerabilities that have the high priority.	0
Related	string	The IDs of the common vulnerabilities and exposures (CVEs) that are related to the vulnerability.	CVE-2023-24881,CVE-2023-24898

Examples

Sample success responses

JSONformat

{
  "CurrentPage": 1,
  "RequestId": "9BFA6D78-07EA-5C0A-9358-E4434573507B",
  "PageSize": 20,
  "TotalCount": 1,
  "GroupedVulItems": [
    {
      "Type": "cve",
      "NntfCount": 59,
      "RaspDefend": 1,
      "HandledCount": 0,
      "GmtLast": 1639371446000,
      "Tags": "Code Execution",
      "LaterCount": 0,
      "AliasName": "RHSA-2017:0184-Important: mysql security update",
      "Name": "oval:com.redhat.rhsa:def:20170184",
      "TotalFixCount": 0,
      "AsapCount": 0,
      "Related": "CVE-2023-24881,CVE-2023-24898"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	no permission	-
400	RdCheckNoPermission	Resource directory account verification has no permission.	-
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-
500	RdCheckInnerError	Resource directory account service internal error.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-07-20	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-05-30	The Error code has changed. The response structure of the API has changed	View Change Details
2023-03-21	The Error code has changed. The response structure of the API has changed	View Change Details