Use DescribeImageVulWhiteList to query the image vulnerability whitelist - Security Center - Alibaba Cloud - Security Center

Queries the image vulnerability whitelist.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:DescribeImageVulWhiteList

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AliasName	string	No	The alias of the vulnerability to query.	CVE-2007-5686:rpath_linux
Lang	string	No	The language type for the request and response. Default value: zh. Valid values: zh: Chinese en: English.	zh
CurrentPage	integer	No	The page number of the current page in a paged query. Paging is used to display results.	1
PageSize	integer	No	The maximum number of entries per page in a paged query. Paging is used to display results. Default value: 20.	20
Source	string	No	The source of the whitelist. Valid values: image: image agentless: agentless.	image

Response elements

Element	Type	Description	Example
	object	The response parameters.
ImageVulWhitelist	array<object>	The image vulnerability whitelist.
	object	The image vulnerability whitelist.
Name	string	The name of the vulnerability.	scan:AVD-2022-953356
AliasName	string	The alias of the vulnerability in the vulnerability advisory.	CVE-2019-19906:in_sasl_add_string
Target	string	The operation target. This parameter is in JSON format and contains the following fields: type: the target type. The value is fixed as repo. target: the target content. Format: namespace/image repository.	{\"type\":\"repo\",\"target\":[\"sas_test/script_0209\",\"sas_test/script\"]}
Reason	string	The reason for adding the vulnerability 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	integer	The primary key ID of the vulnerability.	34032043
PageInfo	object	The paging information for the paged query.
CurrentPage	integer	The page number of the current page in the paged query. Paging starts from page 1.	1
PageSize	integer	The maximum number of entries per page in the paged query. Paging is used to display results.	20
TotalCount	integer	The total number of entries.	100
Count	integer	The number of entries 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 result code. A value of 200 indicates success. Any other value indicates failure. You can use this field to determine the cause of the failure.	200
Message	string	The message returned for the request.	successful
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	911025D0-3D1E-5213-A18A-37EA0C92****
HttpStatusCode	integer	The HTTP status code of the request.	200
TimeCost	integer	The time consumed to process the request, in milliseconds.	1

Examples

Success response

JSON format

{
  "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
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.