文档首页/ 容器镜像服务 SWR/ API参考(企业版)/ API/ 制品扫描/ 手动启动制品扫描 - StartManualScanning
更新时间:2025-11-28 GMT+08:00

手动启动制品扫描 - StartManualScanning

功能介绍

手动启动制品扫描

接口约束

此接口只在企业仓库实例版本25.7.20以上的版本才支持

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    swr:repository:startManualScanning

    Write

    repository *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    -

    -

URI

POST /v2/{project_id}/instances/{instance_id}/namespaces/{namespace_name}/repositories/{repository_name}/artifacts/{reference}/scan

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

instance_id

String

企业仓库实例ID

namespace_name

String

命名空间名称

repository_name

String

制品仓库名称, 如果您的镜像名称repository_name参数中有/,请先把 / 替换成 %2F 再进行请求。注意:使用curl命令请求,需要把 / 替换成 %252F(即 %2F 的 % 被编码为 %25)再次请求。

reference

String

制品摘要

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码:202

启动制品扫描请求已接受

状态码:400

表3 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码:401

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码:403

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码:404

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/namespaces/{namespace_name}/repositories/{repository_name}/artifacts/{reference}/scan

响应示例

状态码

状态码

描述

202

启动制品扫描请求已接受

400

错误的请求

401

鉴权失败

403

禁止访问

404

未找到资源

500

内部错误

错误码

请参见错误码