DescribeImageVulWhiteList - 查询镜像漏洞白名单

查询镜像漏洞白名单。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:DescribeImageVulWhiteListlist
*全部资源
*

请求参数

名称类型必填描述示例值
AliasNamestring

要查询的漏洞的别名。

CVE-2007-5686:rpath_linux
Langstring

指定请求和接收消息的语言类型,默认值为 zh。取值:

  • zh:中文
  • en:英文
zh
CurrentPageinteger

分页查询时,显示的当前页的页码。

1
PageSizeinteger

分页查询时,显示的每页数据的最大条数。默认值为 20。

20
Sourcestring

白名单的来源。取值:

  • image:镜像
  • agentless:agentless
image

返回参数

名称类型描述示例值
object

返回结果信息。

ImageVulWhitelistarray<object>

镜像漏洞白名单列表信息。

VulListobject

镜像漏洞白名单列表信息。

Namestring

漏洞的名称。

scan:AVD-2022-953356
AliasNamestring

漏洞公告中的别名。

CVE-2019-19906:in_sasl_add_string
Targetstring

操作目标。该参数为 JSON 格式,包含以下字段:

  • type:目标类型,固定为 repo
  • target:目标内容,格式:命名空间/镜像仓
{\"type\":\"repo\",\"target\":[\"sas_test/script_0209\",\"sas_test/script\"]}
Reasonstring

添加白名单原因说明。

already config in another way
Typestring

漏洞类型。取值包括:

  • cve:系统漏洞
  • sca:应用漏洞
sca
Idlong

漏洞主键 ID。

34032043
PageInfoobject

分页查询时的页面信息。

CurrentPageinteger

分页查询时,当前页的页码。

1
PageSizeinteger

分页查询时,每页最多显示的数据条数。

20
TotalCountinteger

数据的总条数。

100
Countinteger

当前页显示的数据条数。

20
Successboolean

数据请求是否成功。取值:

  • true:请求成功
  • false:请求失败
true
Codestring

结果代码,200 表示成功,若为别的值则表示失败,调用方可根据此字段判断失败原因。

200
Messagestring

请求结果返回信息。

successful
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

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

请求数据结果的 HTTP 状态码。

200
TimeCostlong

请求处理的耗时,单位毫秒。

1

示例

正常返回示例

JSON格式

{
  "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
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-08-18OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情