1. API Description
Domain name for API request: tcss.intl.tencentcloudapi.com.
This API is used to update the details of an image repository.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
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: UpdateAssetImageRegistryRegistryDetail. |
| 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, which can be harbor. |
| 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). |
3. Output Parameters
| Parameter Name |
Type |
Description |
| HealthCheckErr |
String |
Connection error message Note: This field may return null, indicating that no valid values can be obtained. |
| NameRepeatErr |
String |
Name error message Note: This field may return null, indicating that no valid values can be obtained. |
| RegistryId |
Integer |
Unique repository ID Note: This field may return null, indicating that no valid values can be obtained. |
| 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. |
4. Example
Example1 Updating the details of an image repository
POST / HTTP/1.1
Host: tcss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateAssetImageRegistryRegistryDetail
<Common request parameters>
{
"Name": "test",
"NetType": "public",
"Password": "xxx",
"RegistryRegion": "default",
"RegistryType": "harbor",
"RegistryVersion": "V2",
"Url": "http://127.0.0.1:8080",
"Username": "username"
}
Output Example
{
"Response": {
"RequestId": "xx",
"NameRepeatErr": "xx",
"HealthCheckErr": "xx",
"RegistryId": 4
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
Command Line Interface
6. Error Code
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. |