DescribeImageVulWhiteList - Security Center - Alibaba Cloud Documentation Center

Queries the whitelist of image vulnerabilities.

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:DescribeImageVulWhiteList	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
AliasName	string	No	The alias of the vulnerability that you want to query.	CVE-2007-5686:rpath_linux
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese. en: English.	zh
CurrentPage	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries per page. Default value: 20.	20
Source	string	No	The source of the whitelist. Valid values: image agentless	image

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
ImageVulWhitelist	array<object>	The information about the whitelist of image vulnerabilities.
List	object
Name	string	The name of the vulnerability.	scan:AVD-2022-953356
AliasName	string	The alias of the vulnerability that is specified in Common Vulnerabilities and Exposures (CVE).	CVE-2019-19906:in_sasl_add_string
Target	string	The object on which the query is performed. The value of this parameter is in the JSON format and contains the following fields: type: the object type. The value is fixed to repo. target: the object content. The value is in the Namespace/Image repository format.	{\"type\":\"repo\",\"target\":[\"sas_test/script_0209\",\"sas_test/script\"]}
Reason	string	The reason why the vulnerability is added to the whitelist.	already config in another way
Type	string	The type of the vulnerability. Valid values: cve: system vulnerability sca: application vulnerability	sca
Id	long	The primary key ID of the vulnerability.	34032043
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of entries returned.	100
Count	integer	The number of entries returned on the current page.	20
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Code	string	The status code returned. A value of 200 indicates that the request was successful. Other values indicate that the request failed. You can identify the cause of the failure based on the value of this parameter.	200
Message	string	The message returned.	successful
RequestId	string	The request ID.	911025D0-3D1E-5213-A18A-37EA0C92****
HttpStatusCode	integer	The HTTP status code returned.	200
TimeCost	long	The amount of time that was consumed to process the request. Unit: milliseconds.	1

Examples

Sample success responses

JSONformat

{
  "ImageVulWhitelist": [
    {
      "Name": "scan:AVD-2022-953356",
      "AliasName": "CVE-2019-19906:in_sasl_add_string",
      "Target": "{\\\"type\\\":\\\"repo\\\",\\\"target\\\":[\\\"sas_test/script_0209\\\",\\\"sas_test/script\\\"]}",
      "Reason": "already config in another way",
      "Type": "sca",
      "Id": 34032043
    }
  ],
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 100,
    "Count": 20
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "911025D0-3D1E-5213-A18A-37EA0C92****",
  "HttpStatusCode": 200,
  "TimeCost": 1
}

Error codes

HTTP status code	Error code	Error message	Description
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

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

Change history

Change time	Summary of changes	Operation
2023-08-18	The Error code has changed. The request parameters of the API has changed	View Change Details