Updated on 2024-04-18 GMT+08:00

Manually Replicating Images

Description

Existing images must be manually replicated. Check whether image replication succeeded using the following two ways: 1. If the response status code is 200 and no errors are reported, the image replication succeeded. 2. Use the SWR console or call the API of querying image repository information, if the replicated image tag exists in the target organization of the target region, the image replication succeeded.

Constraints

None

API Calling

For details, see Calling APIs.

URI

POST /v2/manage/namespaces/{namespace}/repos/{repository}/sync_images

Table 1 Path parameters

Parameter

Mandatory

Type

Description

namespace

Yes

String

Organization name. Enter 1 to 64 characters, starting with a lowercase letter and ending with a lowercase letter or digit. Only lowercase letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. Periods, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed.

repository

Yes

String

Image repository name.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format). The value can be application/json;charset=utf-8 application/json

The default value is application/json.

X-Auth-Token

Yes

String

User token.

The token 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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

imageTag

Yes

Array of strings

Image tag list.

override

No

Boolean

Whether to overwrite. The default value is false, which indicates not to overwrite any nonidentical image that has the same name in the target organization.

remoteNamespace

Yes

String

Target organization.

remoteRegionId

Yes

String

Target region ID.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

[Array]

Array of strings

Image tags that are replicated successfully.

Status code: default

Table 5 Response body parameter

Parameter

Type

Description

[Array]

Array of strings

Image tags that fail to be replicated.

Example Request

POST https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/sync_images

{
  "imageTag" : [ "V1" ],
  "override" : true,
  "remoteNamespace" : "sdsad",
  "remoteRegionId" : "cn-north-208"
}

Example Response

[]

SDK Sample Code

The following are SDK sample code:

 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
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.*;

import java.util.List;
import java.util.ArrayList;

public class CreateManualImageSyncRepoSolution {

    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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        SwrClient client = SwrClient.newBuilder()
                .withCredential(auth)
                .withRegion(SwrRegion.valueOf("cn-north-4"))
                .build();
        CreateManualImageSyncRepoRequest request = new CreateManualImageSyncRepoRequest();
        CreateManualImageSyncRepoRequestBody body = new CreateManualImageSyncRepoRequestBody();
        List<String> listbodyImageTag = new ArrayList<>();
        listbodyImageTag.add("V1");
        body.withRemoteRegionId("cn-north-208");
        body.withRemoteNamespace("sdsad");
        body.withOverride(true);
        body.withImageTag(listbodyImageTag);
        request.withBody(body);
        try {
            CreateManualImageSyncRepoResponse response = client.createManualImageSyncRepo(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());
        }
    }
}
 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
# coding: utf-8

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.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = SwrClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SwrRegion.value_of("cn-north-4")) \
        .build()

    try:
        request = CreateManualImageSyncRepoRequest()
        listImageTagbody = [
            "V1"
        ]
        request.body = CreateManualImageSyncRepoRequestBody(
            remote_region_id="cn-north-208",
            remote_namespace="sdsad",
            override=True,
            image_tag=listImageTagbody
        )
        response = client.create_manual_image_sync_repo(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := swr.NewSwrClient(
        swr.SwrClientBuilder().
            WithRegion(region.ValueOf("cn-north-4")).
            WithCredential(auth).
            Build())

    request := &model.CreateManualImageSyncRepoRequest{}
	var listImageTagbody = []string{
        "V1",
    }
	overrideCreateManualImageSyncRepoRequestBody:= true
	request.Body = &model.CreateManualImageSyncRepoRequestBody{
		RemoteRegionId: "cn-north-208",
		RemoteNamespace: "sdsad",
		Override: &overrideCreateManualImageSyncRepoRequestBody,
		ImageTag: listImageTagbody,
	}
	response, err := client.CreateManualImageSyncRepo(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code in other programming languages, see the Sample Code tab in the API Explorer.

Status Codes

Status Code

Description

200

Image tags that fail to be replicated.

400

Request error.

401

Authentication failed.

404

The organization or the repository does not exist.

500

Internal error.

Error Codes

For details, see Error Codes.