文档

PublicPreCheckImageScanTask - 查询容器镜像安全扫描覆盖的镜像数和待消耗的授权数

更新时间:

查询容器镜像安全扫描覆盖的镜像数和待消耗的授权数。

接口说明

本接口可帮您预检镜像安全扫描待消耗的授权数,以确保您在创建镜像安全扫描任务之前,已知晓镜像安全扫描任务消耗的授权数。如果授权数不足,您需要购买足够的授权数,以避免因授权数不足导致镜像安全扫描任务执行中断。

调用本接口时,如果未设置非必选的请求参数,则查询扫描所有容器镜像覆盖的镜像数和待消耗的授权数。如果设置了非必选的请求参数,则按照所设置的参数,筛选符合条件的容器镜像在进行安全扫描时覆盖的镜像数和待消耗的授权数。

调试

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

授权信息

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

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

请求参数

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

访问源的 IP 地址。

192.168.XX.XX
RegistryTypesstring

镜像仓的类型。多个镜像仓的类型之间使用半角逗号(,)分隔。取值:

  • acr
  • harbor
  • quay
acr
RegionIdsstring

镜像的地域 ID。多个地域 ID 之间使用半角逗号(,)分隔。

cn-hangzhou
InstanceIdsstring

ACR 镜像仓实例的 ID。多个实例的 ID 之间使用半角逗号(,)分隔。

i-uf6j8vq9l4r5ntht****
RepoNamespacesstring

镜像仓的命名空间。多个命名空间之间使用半角逗号(,)分隔。

hanghai-namespace
RepoIdsstring

镜像仓的 ID。多个镜像仓的 ID 之间使用半角逗号(,)分隔。

crr-vridcl4****
RepoNamesstring

镜像仓的名称。多个镜像仓的名称之间使用半角逗号(,)分隔。

centos
Digestsstring

镜像的摘要的 SHA256 值。多个摘要的 SHA256 值之间使用半角逗号(,)分隔。

6a5e103187b31a94592a47a5858617f7****
Tagsstring

镜像的标签。多个标签之间使用半角逗号(,)分隔。

0.2

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

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

F9353221-40F4-5F98-B73C-2803DC804033
Dataobject

接口调用成功时,返回的数据。

ScanImageCountinteger

镜像安全扫描待消耗的授权数。

3
NeedAuthCountinteger

镜像安全扫描覆盖的镜像的总数量。

6

示例

正常返回示例

JSON格式

{
  "RequestId": "F9353221-40F4-5F98-B73C-2803DC804033",
  "Data": {
    "ScanImageCount": 3,
    "NeedAuthCount": 6
  }
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2022-08-01API 内部配置变更,不影响调用查看变更详情
2022-08-01API 内部配置变更,不影响调用查看变更详情
2022-01-13新增 OpenAPI查看变更详情