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

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

接口说明

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

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

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

操作	访问级别	资源类型	条件关键字	关联操作
yundun-sas:PublicPreCheckImageScanTask	none	全部资源 ``	无	无

名称	类型	必填	描述	示例值
SourceIp	string	否	访问源的 IP 地址。	192.168.XX.XX
RegistryTypes	string	否	镜像仓的类型。多个镜像仓的类型之间使用半角逗号（,）分隔。取值： acr harbor quay	acr
RegionIds	string	否	镜像的地域 ID。多个地域 ID 之间使用半角逗号（,）分隔。	cn-hangzhou
InstanceIds	string	否	ACR 镜像仓实例的 ID。多个实例的 ID 之间使用半角逗号（,）分隔。	i-uf6j8vq9l4r5ntht****
RepoNamespaces	string	否	镜像仓的命名空间。多个命名空间之间使用半角逗号（,）分隔。	hanghai-namespace
RepoIds	string	否	镜像仓的 ID。多个镜像仓的 ID 之间使用半角逗号（,）分隔。	crr-vridcl4****
RepoNames	string	否	镜像仓的名称。多个镜像仓的名称之间使用半角逗号（,）分隔。	centos
Digests	string	否	镜像的摘要的 SHA256 值。多个摘要的 SHA256 值之间使用半角逗号（,）分隔。	6a5e103187b31a94592a47a5858617f7****
Tags	string	否	镜像的标签。多个标签之间使用半角逗号（,）分隔。	0.2

名称	类型	描述	示例值
	object	请求返回数据。
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	F9353221-40F4-5F98-B73C-2803DC804033
Data	object	接口调用成功时，返回的数据。
ScanImageCount	integer	镜像安全扫描待消耗的授权数。	3
NeedAuthCount	integer	镜像安全扫描覆盖的镜像的总数量。	6

正常返回示例

JSON格式

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

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

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