全部产品
Search
文档中心

云安全中心:PublicCreateImageScanTask - 创建镜像扫描任务

更新时间:Nov 25, 2024

创建镜像扫描任务,不受单个主任务的限制。

接口说明

建议您在使用本接口前,先使用 PublicPreCheckImageScanTask 接口查询容器镜像安全扫描覆盖的镜像数和消耗的授权数,确保镜像安全扫描所需的授权数足够,避免因授权数不够导致镜像安全扫描任务中断。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
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 值之间使用半角逗号(,)分隔。

6a5e103187b31a94592a47a5858617f7a6c
Tagsstring

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

0.2

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

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

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

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

TaskIdstring

扫描任务的 ID。

a410bb3e68c217a3368bc0238c66886d
TotalCountinteger

扫描镜像的总数量。

5
FinishCountinteger

已完成扫描的镜像的数量。

5
CollectTimelong

采集镜像信息的时间戳,单位为毫秒。

1644286364150
ExecTimelong

扫描任务开始运行的时间戳,单位为毫秒。

1644286364150
Statusstring

扫描任务的状态。取值:

  • INIT:初始化中。
  • PRE_ANALYZER:预分析中。
  • SUCCESS:执行成功。
  • FAIL:执行失败。
SUCCESS
Progressinteger

扫描任务进度的百分比。

100
Resultstring

扫描任务的执行结果。取值:

  • SUCCESS:扫描任务执行成功。
  • TASK_NOT_SUPPORT_REGION:镜像在不支持扫描的地域。
说明 镜像安全扫描支持的地域,请参见本文档返回参数表后的镜像安全扫描支持的地域的表格。
SUCCESS
CanCreateboolean

是否可以继续创建扫描任务。取值:

  • true:可以继续创建扫描任务。
  • false:无法继续创建扫描任务。
说明 默认支持同时存在 10 个扫描任务,超过 10 个扫描任务时,使用本接口创建扫描任务会失败。您需要等待已有的 10 个扫描任务中有扫描任务完成后,才可以继续创建新的扫描任务。
true

镜像安全扫描支持的地域

地域城市地域 ID
华东 1杭州cn-hangzhou
华东 2上海cn-shanghai
华南 1深圳cn-shenzhen
华北 1青岛cn-qingdao
华北 2北京cn-beijing
华北 3张家口cn-zhangjiakou
华北 5呼和浩特cn-huhehaote
中国香港中国香港cn-hongkong
亚太东北 1东京ap-northeast-1
亚太东南 5雅加达ap-southeast-5
美国西部 1硅谷us-west-1
美国东部 1弗吉尼亚us-east-1
欧洲中部 1法兰克福eu-central-1
英国伦敦伦敦eu-west-1

示例

正常返回示例

JSON格式

{
  "RequestId": "F9353221-40F4-5F98-B73C-2803DC804033",
  "Data": {
    "TaskId": "a410bb3e68c217a3368bc0238c66886d",
    "TotalCount": 5,
    "FinishCount": 5,
    "CollectTime": 1644286364150,
    "ExecTime": 1644286364150,
    "Status": "SUCCESS",
    "Progress": 100,
    "Result": "SUCCESS",
    "CanCreate": true
  }
}

错误码

HTTP status code错误码错误信息描述
400BeyondQuataPlease check the scan quota请检查扫描授权数
400TaskNumEmptyCreate task quantity is empty.创建任务数量为空。
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

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

变更历史

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