文档

AddPrivateRegistry - 接入自建镜像仓

更新时间:

接入用户自建镜像仓。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
RegistryTypestring

私有镜像仓库类型。 取值:

  • harbor:harbor 环境
  • quay:quay 环境
harbor
RegistryVersionstring

镜像仓版本。取值:

  • V1:1.0 版本
  • V2:2.0 版本
V2
ProtocolTypelong

协议类型。取值:

  • 1:http
  • 2:https
2
NetTypelong

网络类型。取值:

  • 1:公网
  • 2:vpc
2
VpcIdstring

VPC 的实例 ID。

vpc-wz9hs3e5*******908kd
RegistryHostIpstring

仓库 IP 地址。

114.55.**.**
DomainNamestring

仓库域名。

example.com
UserNamestring

镜像仓库用户名

xxxxx
Passwordstring

密码。

******
RegistryRegionIdstring

地域 ID。

说明 您可以调用 ListImageRegistryRegion 接口获取支持的地域 ID。
cn-hangzhou
TransPerHourinteger

每小时扫描的镜像数。

10
ExtraParamstring

镜像仓库附加参数,使用 quay 时必填。包含:

  • namespace:命名空间
  • authToken:授权 token
[{"namespace":"aa","authToken":"aa"}]
Portinteger

端口号。

80

返回参数

名称类型描述示例值
object

请求返回参数。

RequestIdstring

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

F8B6F758-BCD4-597A-8A2C-DA5A552C****
Dataobject

处理结果。

VpcIdstring

VPC 的实例 ID。

vpc-2vchkxmf2j9yjt3x2****
Tokenstring

Token 值。

3c3c602c-fa1f-4bc0-992f-b4b2cac7****
TransPerHourinteger

每小时扫描任务数。

10
AliUidlong

用户 ID。

1766185894104***
RegistryTypestring

镜像仓库类型。取值:

  • harbor:harbor 环境
  • quay:quay 环境
harbor
DomainNamestring

仓库域名。

example.com
RegionIdstring

仓库地域 ID。

cn-hangzhou
Passwordstring

密码。

***********
NetTypelong

网络类型。取值:

  • 1:公网
  • 2:vpc
2
RegistryVersionstring

镜像仓版本,默认值"-"。取值:

  • -:默认
  • V1:1.0 版本
  • V2:2.0 版本
V2
ProtocolTypelong

协议类型。取值:

  • 1:http
  • 2:https
2
RegistryHostIpstring

仓库 IP 地址。

114.55.**.**
UserNamestring

用户名。

******
Idlong

唯一 ID。

273698***

示例

正常返回示例

JSON格式

{
  "RequestId": "F8B6F758-BCD4-597A-8A2C-DA5A552C****",
  "Data": {
    "VpcId": "vpc-2vchkxmf2j9yjt3x2****",
    "Token": "3c3c602c-fa1f-4bc0-992f-b4b2cac7****",
    "TransPerHour": 10,
    "AliUid": 0,
    "RegistryType": "harbor",
    "DomainName": "example.com",
    "RegionId": "cn-hangzhou",
    "Password": "***********",
    "NetType": 2,
    "RegistryVersion": "V2",
    "ProtocolType": 2,
    "RegistryHostIp": "114.55.**.**",
    "UserName": "******",
    "Id": 0
  }
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

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

变更历史

变更时间变更内容概要操作
2023-09-07OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Port
  • 本页导读 (1)
文档反馈