调用PublicCreateImageScanTask创建镜像扫描任务_云安全中心(Security Center)-阿里云帮助中心

创建镜像扫描任务。

接口说明

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
yundun-sas:PublicCreateImageScanTask	Write	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
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 值之间使用半角逗号（,）分隔。	6a5e103187b31a94592a47a5858617f7a6c
Tags	string	否	镜像的标签。多个标签之间使用半角逗号（,）分隔。	0.2

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	F9353221-40F4-5F98-B73C-2803DC804033
Data	object	接口调用成功时，返回的数据。
TaskId	string	扫描任务的 ID。	a410bb3e68c217a3368bc0238c66886d
TotalCount	integer	扫描镜像的总数量。	5
FinishCount	integer	已完成扫描的镜像的数量。	5
CollectTime	long	采集镜像信息的时间戳，单位为毫秒。	1644286364150
ExecTime	long	扫描任务开始运行的时间戳，单位为毫秒。	1644286364150
Status	string	扫描任务的状态。取值： INIT：初始化中。 PRE_ANALYZER：预分析中。 SUCCESS：执行成功。 FAIL：执行失败。	SUCCESS
Progress	integer	扫描任务进度的百分比。	100
Result	string	扫描任务的执行结果。取值： SUCCESS：扫描任务执行成功。 TASK_NOT_SUPPORT_REGION：镜像在不支持扫描的地域。说明镜像安全扫描支持的地域，请参见本文档返回参数表后的镜像安全扫描支持的地域的表格。	SUCCESS
CanCreate	boolean	是否可以继续创建扫描任务。取值： 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	错误码	错误信息	描述
400	BeyondQuata	Please check the scan quota	请检查扫描授权数
403	NoPermission	caller has no permission	当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作。
500	ServerError	ServerError	服务故障，请稍后重试！