Domain name for API request: tcss.intl.tencentcloudapi.com.
This API is used to add the details of an image repository.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: AddAssetImageRegistryRegistryDetail. |
| Version | Yes | String | Common Params. The value used for this API: 2020-11-01. |
| Region | No | String | Common Params. This parameter is not required. |
| Name | Yes | String | Repository name |
| Username | Yes | String | Username |
| Password | Yes | String | Password |
| Url | Yes | String | Repository URL |
| RegistryType | Yes | String | Repository type. Valid values: harbor, quay, jfrog, aws, azure, and other-tcr. |
| NetType | Yes | String | Network type, which can be public (public network). |
| RegistryVersion | No | String | Repository version |
| RegistryRegion | No | String | Region. Default value: default. |
| SpeedLimit | No | Integer | Speed limit |
| Insecure | No | Integer | Valid values: 0 (secure mode with certificate verification, which is the default value); 1 (unsecure mode that skips certificate verification). |
| ConnDetectConfig.N | No | Array of ConnDetectConfig | |
| NeedScan | No | Boolean | Whether authorization and scanning are performed automatically. For full synchronization, only images of the latest version are involved. For incremental synchronization, all new images are involved. |
| SyncMode | No | Integer | Synchronization method. 0: full synchronization; 1: incremental synchronization. |
| WebhookUrl | No | String | Webhook access address. |
| WebhookToken | No | String | Webhook access token. |
| InstanceId | No | String | TCR instance ID. |
| Parameter Name | Type | Description |
|---|---|---|
| HealthCheckErr | String | Connection error message |
| NameRepeatErr | String | Error message of the name |
| RegistryId | Integer | Repository unique id |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to add details for an image repository.
POST / HTTP/1.1
Host: tcss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddAssetImageRegistryRegistryDetail
<Common request parameters>
{
"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"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | A CAM signature/authentication error occurred. |
| FailedOperation | The operation failed. |
| FailedOperation.DataValueNotCorrect | The response data value is incorrect. |
| InternalError | An internal error occurred. |
| InvalidParameter | The parameter is incorrect. |
| InvalidParameter.InvalidFormat | The parameter format is incorrect. |
| InvalidParameter.MissingParameter | The required parameter is missing. |
| InvalidParameterValue | The parameter value is incorrect. |
| ResourceNotFound | The resource does not exist. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback