Modifying a Target Registry for Image Replication
Function
This API is used to modify a target registry for image replication.
Constraints
None.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{project_id}/instances/{instance_id}/registries/{registry_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
instance_id |
Yes |
String |
ID of an SWR Enterprise Edition instance. |
registry_id |
Yes |
Integer |
Replication registry ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Name of a target registry. The value can contain 1 to 64 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed. |
description |
No |
String |
Description of a target registry. |
type |
Yes |
String |
Registry type. The value can be swr-pro (open-source Harbor), swr-pro-internal (SWR Enterprise Edition), or huawei-SWR (SWR Basic Edition). |
project_id |
No |
String |
ID of the project that an SWR Enterprise Edition instance belongs to. This parameter is mandatory when type is set to swr-pro-internal. |
region_id |
No |
String |
Region ID. This parameter is mandatory when type is set to swr-pro-internal. |
instance_id |
No |
String |
ID of an SWR Enterprise Edition instance. This parameter is mandatory when type is set to swr-pro-internal. |
url |
Yes |
String |
Address of a target registry. |
credential |
Yes |
Credential object |
Registry authentication information. |
dns_conf |
No |
DnsConf object |
DNS settings. |
insecure |
Yes |
Boolean |
Whether to verify a certificate remotely. |
Response Parameters
Status code: 200
Successful update.
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason. |
Example Requests
PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/registries/{registry_id} { "description": "", "insecure": true, "name": "test112", "type": "swr-pro-internal", "url": "https://testbasic-vwnajp.swr-pro.myhuaweicloud.com", "credential": { "type": "basic", "access_key": "AKIAIOSFODNN7...", "access_secret": "wJalrXUtnFEM..." }, }
Example Responses
None
SDK Sample Code
The SDK sample code is as follows.
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.swr.v2.region.SwrRegion; import com.huaweicloud.sdk.swr.v2.*; import com.huaweicloud.sdk.swr.v2.model.*; public class UpdateInstanceRegistrySolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); SwrClient client = SwrClient.newBuilder() .withCredential(auth) .withRegion(SwrRegion.valueOf("<YOUR REGION>")) .build(); UpdateInstanceRegistryRequest request = new UpdateInstanceRegistryRequest(); request.withInstanceId("{instance_id}"); request.withRegistryId({registry_id}); UpdateRegistryRequestBody body = new UpdateRegistryRequestBody(); Credential credentialbody = new Credential(); credentialbody.withType("basic") .withAccessKey("AKIAIOSFODNN7...") .withAccessSecret("wJalrXUtnFEM..."); body.withInsecure(true); body.withCredential(credentialbody); body.withUrl("https://testbasic-vwnajp.swr-pro.myhuaweicloud.com"); body.withType("swr-pro-internal"); body.withDescription(""); body.withName("test112"); request.withBody(body); try { UpdateInstanceRegistryResponse response = client.updateInstanceRegistry(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkswr.v2.region.swr_region import SwrRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkswr.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = SwrClient.new_builder() \ .with_credentials(credentials) \ .with_region(SwrRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateInstanceRegistryRequest() request.instance_id = "{instance_id}" request.registry_id = {registry_id} credentialbody = Credential( type="basic", access_key="AKIAIOSFODNN7...", access_secret="wJalrXUtnFEM..." ) request.body = UpdateRegistryRequestBody( insecure=True, credential=credentialbody, url="https://testbasic-vwnajp.swr-pro.myhuaweicloud.com", type="swr-pro-internal", description="", name="test112" ) response = client.update_instance_registry(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" swr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := swr.NewSwrClient( swr.SwrClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateInstanceRegistryRequest{} request.InstanceId = "{instance_id}" request.RegistryId = int32({registry_id}) credentialbody := &model.Credential{ Type: "basic", AccessKey: "AKIAIOSFODNN7...", AccessSecret: "wJalrXUtnFEM...", } descriptionUpdateRegistryRequestBody:= "" request.Body = &model.UpdateRegistryRequestBody{ Insecure: true, Credential: credentialbody, Url: "https://testbasic-vwnajp.swr-pro.myhuaweicloud.com", Type: "swr-pro-internal", Description: &descriptionUpdateRegistryRequestBody, Name: "test112", } response, err := client.UpdateInstanceRegistry(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Successful update. |
400 |
Request error. |
401 |
Authentication failed. |
403 |
Access denied. |
404 |
Resource not found. |
500 |
Internal error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot