1. 接口描述
接口请求域名: tcss.tencentcloudapi.com 。
新增单个镜像仓库详细信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:AddAssetImageRegistryRegistryDetail。 |
| Version | 是 | String | 公共参数,本接口取值:2020-11-01。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Name | 是 | String | 仓库名 示例值:tcr2 |
| Username | 是 | String | 用户名 示例值:admin |
| Password | 是 | String | 密码 示例值:passwd |
| Url | 是 | String | 仓库url 示例值:http://good.com.cn |
| RegistryType | 是 | String | 仓库类型,列表:harbor,quay,jfrog,aws,azure,other-tcr 示例值:harbor |
| NetType | 是 | String | 网络类型,列表:public(公网) 示例值:public |
| RegistryVersion | 否 | String | 仓库版本 示例值:v1.x |
| RegistryRegion | 否 | String | 区域,列表:default(默认) 示例值:default |
| SpeedLimit | 否 | Integer | 限速 示例值:10 |
| Insecure | 否 | Integer | 安全模式(证书校验):0(默认) 非安全模式(跳过证书校验):1 示例值:0 |
| ConnDetectConfig.N | 否 | Array of ConnDetectConfig | 联通性检测的记录ID 示例值:{ "Quuid":"5a540076-d38a-4078-aa98-e7c86371d322", "Uuid":"5a540076-d38a-4078-aa98-e7c86371d322" } |
| NeedScan | 否 | Boolean | 是否自动授权&扫描,选择全量同步时只针对最新版本镜像,增量同步时则包含所有新增镜像 示例值:true |
| SyncMode | 否 | Integer | 同步方式,0全量同步,1增量同步 示例值:0 |
| WebhookUrl | 否 | String | webhook接入地址 示例值:http://u.yd.qcloud.com/tcss/registry/webhook_id |
| WebhookToken | 否 | String | webhook接入token 示例值:token |
| InstanceId | 否 | String | tcr实例ID 示例值:tcr-xxx |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| HealthCheckErr | String | 连接错误信息 示例值:"connect closed" |
| NameRepeatErr | String | 名称错误信息 示例值:"name repeat err" |
| RegistryId | Integer | 仓库唯一id 示例值:1002 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 新增单个镜像仓库详细信息
新增单个镜像仓库详细信息
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddAssetImageRegistryRegistryDetail
<公共请求参数>
{
"Username": "usename",
"Name": "admin",
"Url": "http://127.0.0.1:8080",
"RegistryVersion": "V2",
"RegistryRegion": "default",
"NetType": "public",
"Password": "password",
"RegistryType": "harbor"
}
输出示例
{
"Response": {
"HealthCheckErr": "connect closed",
"NameRepeatErr": "name repeat err",
"RegistryId": 1002,
"RequestId": "f8d97649-ca1b-4f94-8ed4-40052a40d426"
}
}
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 | 操作失败。 |
| FailedOperation.DataValueNotCorrect | 响应数据值不正确。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidFormat | 参数格式错误。 |
| InvalidParameter.MissingParameter | 缺少必须参数。 |
| InvalidParameterValue | 参数取值错误。 |
| ResourceNotFound | 资源不存在。 |