接入用户自建镜像仓。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| yundun-sas:AddPrivateRegistry | create | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegistryType | string | 是 | 私有镜像仓库类型。 取值：
| harbor |
| RegistryVersion | string | 是 | 镜像仓版本。取值：
| V2 |
| ProtocolType | long | 是 | 协议类型。取值：
| 2 |
| NetType | long | 是 | 网络类型。取值：
| 2 |
| VpcId | string | 否 | VPC 的实例 ID。 | vpc-wz9hs3e5*******908kd |
| RegistryHostIp | string | 是 | 仓库 IP 地址。 | 114.55.**.** |
| DomainName | string | 是 | 仓库域名。 | example.com |
| UserName | string | 是 | 镜像仓库用户名 | xxxxx |
| Password | string | 是 | 密码。 | ****** |
| RegistryRegionId | string | 是 | 地域 ID。 说明
您可以调用 ListImageRegistryRegion 接口获取支持的地域 ID。
| cn-hangzhou |
| TransPerHour | integer | 否 | 每小时扫描的镜像数。 | 10 |
| ExtraParam | string | 否 | 镜像仓库附加参数，使用 quay 时必填。包含：
| [{"namespace":"aa","authToken":"aa"}] |
| Port | integer | 否 | 端口号。 | 80 |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 403 | NoPermission | caller has no permission | 当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作。 |
| 500 | ServerError | ServerError | 服务故障，请稍后重试！ |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-09-07 | OpenAPI 入参发生变更 | 查看变更详情 |