新增镜像仓库 - AddRegistry
功能介绍
新增镜像仓库
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/image/registries
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
registry_name |
是 |
String |
参数解释: 仓库名称 约束限制: 不涉及 取值范围: 字符长度1-128位 默认取值: 不涉及 |
|
registry_type |
是 |
String |
参数解释: 镜像仓类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
api_version |
是 |
String |
参数解释: 镜像仓接口版本 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
protocol |
是 |
String |
参数解释: 协议类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
registry_addr |
是 |
String |
参数解释: 镜像仓地址 约束限制: 网址/IP:端口。如:myharbor.com。 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
registry_username |
是 |
String |
参数解释: 用于登录镜像仓的用户名。 约束限制: 不涉及 取值范围: 字符长度1-128位 默认取值: 不涉及 |
|
registry_password |
是 |
String |
参数解释: 用于登录镜像仓的密码。仅用于访问镜像仓,HSS服务不会存储您的镜像仓密码。 约束限制: 不涉及 取值范围: 字符长度1-128位 默认取值: 不涉及 |
|
namespace |
否 |
String |
参数解释: 镜像仓项目,用来指定扫描组件要上传到的镜像仓目录。get_scan_image_channel为Other时需要填写。 约束限制: 不涉及 取值范围: 字符长度1-128位 默认取值: 不涉及 |
|
connect_cluster_id |
是 |
String |
参数解释: 承载集群id。请选择一个已接入HSS的集群作为承载集群,镜像同步组件和扫描组件会以任务的方式运行在您所选的集群上,来帮助主机安全获取您的镜像数据和扫描镜像安全风险。 约束限制: 不涉及 取值范围: 字符长度1-64位 默认取值: 不涉及 |
|
get_scan_image_channel |
是 |
String |
参数解释: 获取扫描组件的方式 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
响应参数
状态码:200
请求已成功
无
请求示例
接入三方镜像仓。
POST https://{endpoint}/v5/{project_id}/image/registries?enterprise_project_id=all_granted_eps
{
"registry_name" : "my-harbor",
"registry_type" : "Harbor",
"api_version" : "V2",
"protocol" : "http",
"registry_addr" : "myharbor.com",
"registry_username" : "me",
"registry_password" : 123456,
"connect_cluster_id" : "xxx",
"get_scan_image_channel" : "Swr"
}
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。