All Products
Search
Document Center

Security Center:DescribeImageVulWhiteList

Last Updated:Feb 20, 2024

Queries the whitelist of image vulnerabilities.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeImageVulWhiteListRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AliasNamestringNo

The alias of the vulnerability that you want to query.

CVE-2007-5686:rpath_linux
LangstringNo

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

  • zh: Chinese.
  • en: English.
zh
CurrentPageintegerNo

The number of the page to return.

1
PageSizeintegerNo

The number of entries per page. Default value: 20.

20
SourcestringNo

The source of the whitelist. Valid values:

  • image
  • agentless
image

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

ImageVulWhitelistobject []

The information about the whitelist of image vulnerabilities.

Namestring

The name of the vulnerability.

scan:AVD-2022-953356
AliasNamestring

The alias of the vulnerability that is specified in Common Vulnerabilities and Exposures (CVE).

CVE-2019-19906:in_sasl_add_string
Targetstring

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\"]}
Reasonstring

The reason the vulnerability is added to the whitelist.

already config in another way
Typestring

The type of the vulnerability. Valid values:

  • cve: system vulnerability
  • sca: application vulnerability
sca
Idlong

The primary key ID of the vulnerability.

34032043
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries per page.

20
TotalCountinteger

The total number of entries returned.

100
Countinteger

The number of entries returned on the current page.

20
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
Codestring

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
Messagestring

The message returned.

successful
RequestIdstring

The request ID.

911025D0-3D1E-5213-A18A-37EA0C92****
HttpStatusCodeinteger

The HTTP status code returned.

200
TimeCostlong

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 codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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

Change history

Change timeSummary of changesOperation
2023-08-18The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 500
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Source