获取扫描组件镜像上传指令 - ShowImageUploadCommand
功能介绍
获取镜像上传指令，上传的镜像是“镜像仓接入功能”和“镜像仓扫描功能”需要的组件
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/image/registries/image-upload-command
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
registry_addr |
是 |
String |
参数解释： 镜像仓地址 约束限制： 网址/IP:端口。如：myharbor.com。 取值范围： 字符长度1-256位 默认取值： 不涉及 |
|
namespace |
是 |
String |
参数解释： 镜像仓项目,用来指定扫描组件要上传到的镜像仓目录。 约束限制： 不涉及 取值范围： 字符长度1-128位 默认取值： 不涉及 |
|
username |
是 |
String |
参数解释： 用于登录镜像仓的用户名。 约束限制： 不涉及 取值范围： 字符长度1-128位 默认取值： 不涉及 |
|
password |
是 |
String |
参数解释： 用于登录镜像仓的密码。仅用于生成命令，HSS服务不会存储您的镜像仓密码。 约束限制： 不涉及 取值范围： 字符长度1-128位 默认取值： 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
image_command |
String |
参数解释： 上传镜像指令 取值范围： 字符长度1-1024位 |
|
images_download_url |
String |
参数解释： 镜像下载链接 取值范围： 字符长度1-256位 |
|
swr_image_pull_command |
String |
参数解释： SWR镜像获取指令 取值范围： 字符长度1-1024位 |
请求示例
获取镜像上传指令，上传的镜像是“镜像仓接入功能”和“镜像仓扫描功能”需要的组件，镜像仓地址为hub.docker.com，组织名称为test，用户名为xxx，密码为xxxxxx
GET https://{endpoint}/v5/{project_id}/image/registries/image-upload-command?registry_addr=hub.docker.com&namespace=test&username=xxx&password=xxxxxx&enterprise_project_id=all_granted_eps
响应示例
状态码：200
请求已成功
{
"image_command" : "docker load xxx",
"images_download_url" : "https://xxx.zip",
"swr_image_pull_command" : "docker pull xxx"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
