1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
添加镜像仓库信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:AddImageRegistry。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Name | 是 | String | 镜像仓库名 示例值:测试环境内网harbor |
| MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-12e1se11"] |
| Username | 否 | String | 镜像仓库账号 示例值:admin |
| Password | 否 | String | 镜像仓库密码 示例值:Har**** |
| Url | 否 | String | 镜像仓库url 示例值:http://172.16.0.25 |
| RegistryType | 否 | String | 镜像仓库类型 枚举值:
示例值:harbor |
| NetType | 否 | String | 网络类型 枚举值:
示例值:public |
| RegistryVersion | 否 | String | api版本 示例值:1.0 |
| RegistryRegion | 否 | String | 镜像仓库所在region 示例值:ap-guangzhou |
| SpeedLimit | 否 | Integer | 访问限速值 示例值:50 |
| Insecure | 否 | Integer | 是否忽略证书 枚举值:
示例值:1 |
| NeedScan | 否 | Boolean | 是否立即同步 示例值:false |
| SyncMode | 否 | Integer | 同步模式,0-全量同步 示例值:0 |
| InstanceId | 否 | String | 镜像仓库实例id 示例值:harbor-instance |
| ConnectivityDetectConfig.N | 否 | Array of ConnectivityDetectConfig | 扫描使用的链接配置 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RegistryId | Integer | 镜像仓库id 示例值:33 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 添加镜像仓库信息
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddImageRegistry
<公共请求参数>
{
"Name": "测试环境内网harbor",
"Username": "admin",
"Password": "Har********",
"Url": "http://172.16.0.25",
"RegistryType": "harbor",
"NetType": "public",
"RegistryVersion": "1.0",
"RegistryRegion": "ap-guangzhou",
"SpeedLimit": 50,
"Insecure": 1,
"NeedScan": false,
"SyncMode": 0,
"InstanceId": "harbor-instance",
"ConnectivityDetectConfig": [
{
"Quuid": "2d85debe-8049-****-****-2f29000a6a23",
"Uuid": "2d85debe-8049-****-****-2f29000a6a23"
}
]
}
输出示例
{
"Response": {
"RegistryId": 33,
"RequestId": "cff2e236-e654-4db3-baf5-3f97e4c891ba"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidFilter | 无效的过滤器 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.ResourceId | InvalidParameter.ResourceId |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| UnauthorizedOperation.NoPermission | UnauthorizedOperation.NoPermission |
| UnknownParameter | 未知参数错误。 |