Help Center/ SoftWare Repository for Container/ API Reference (Enterprise Edition)/ API/ Image Replication Management/ Creating an Image Replication Policy
Updated on 2025-09-26 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Creating an Image Replication Policy

Function

This API is used to create an image replication policy.

Constraints

None.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/instances/{instance_id}/replication/policies

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

instance_id

Yes

String

ID of an SWR Enterprise Edition instance.

Request Parameters

Table 2 Request header 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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Policy name. The value can contain 1 to 256 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

description

No

String

Policy description.

src_registry

No

ReplicationRegistry object

This parameter is mandatory for image pull. Either src_registry or dest_registry must be transferred.

dest_registry

No

ReplicationRegistry object

This parameter is mandatory for image push. Either src_registry or dest_registry must be transferred.

dest_namespace

No

String

Name of the target namespace. By default, the value is left empty.

filters

Yes

Array of Filter objects

Filter. (Currently, only Harbor repositories are supported.)

repo_scope_mode

Yes

String

Repository selection mode. The value options are regular and selection.

trigger

Yes

TriggerConfig object

Trigger configuration.

override

No

Boolean

Whether to overwrite an image. The default value is false.

enabled

Yes

Boolean

Whether to enable a resource. The default value is false.
Table 4 ReplicationRegistry

Parameter

Mandatory

Type

Description

id

Yes

Long

The registry ID.
Table 5 Filter

Parameter

Mandatory

Type

Description

type

Yes

String

Filter type. The options are name and tag.

value

Yes

String

Regular expression corresponding to the filter type. If type is set to name, the regular expression is the namespace and artifact repository, for example, library/**. If type is set to tag, the regular expression is the artifact tag, for example, **repo and *tag. If there are multiple regular expressions, separate them with commas (,) and add {} at the outermost layer, for example, library/{test,test,*test}.
Table 6 TriggerConfig

Parameter

Mandatory

Type

Description

type

Yes

String

Trigger type. For image signing and retention policies, the options are manual and scheduled (scheduled + manual). For image replication policies, the options are manual, scheduled (scheduled + manual), and event_based (event-triggered + manual).

trigger_settings

No

TriggerSetting object

Trigger settings. This parameter is required only when type is set to scheduled.
Table 7 TriggerSetting

Parameter

Mandatory

Type

Description

cron

No

String

Cron settings, in the format of '* * * * * *'. cron is based on the UTC time.

Response Parameters

Status code: 201

Table 8 Response body parameters

Parameter

Type

Description

id

Integer

Namespace ID.

Status code: 400

Table 9 Response body parameters

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

Table 10 Response body parameters

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

Table 11 Response body parameters

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

Table 12 Response body parameters

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

Table 13 Response body parameters

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

  • Creating a replication policy for pushing images to the target registry

    POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/replication/policies

{
  "name" : "harbor-pull",
  "dest_registry" : {
    "id" : 3
  },
  "dest_namespace" : "aa",
  "filters" : [ {
    "type" : "name",
    "value" : "library/**"
  }, {
    "type" : "tag",
    "value" : "**"
  } ],
  "repo_scope_mode" : "regular",
  "trigger" : {
    "type" : "manual"
  },
  "override" : true,
  "enabled" : true
}

  • Creating a replication policy for pulling images from the target registry

    POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/replication/policies

{
  "name" : "swr-pull",
  "src_registry" : {
    "id" : 12
  },
  "dest_namespace" : "aa",
  "filters" : [ {
    "type" : "name",
    "value" : "aa/**"
  }, {
    "type" : "tag",
    "value" : "**"
  } ],
  "repo_scope_mode" : "regular",
  "trigger" : {
    "type" : "manual"
  },
  "override" : true,
  "enabled" : true
}

Example Responses

Status code: 201

The policy is created successfully.

{
  "id" : 1
}

SDK Sample Code

The SDK sample code is as follows.

Java

  • Creating a replication policy for pushing images to the target registry

     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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
    		 
    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 CreateInstanceReplicationPolicySolution {

    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();
        CreateInstanceReplicationPolicyRequest request = new CreateInstanceReplicationPolicyRequest();
        request.withInstanceId("{instance_id}");
        CreateReplicationPolicyRequestBody body = new CreateReplicationPolicyRequestBody();
        TriggerConfig triggerbody = new TriggerConfig();
        triggerbody.withType("manual");
        List<Filter> listbodyFilters = new ArrayList<>();
        listbodyFilters.add(
            new Filter()
                .withType("name")
                .withValue("library/**")
        );
        listbodyFilters.add(
            new Filter()
                .withType("tag")
                .withValue("**")
        );
        ReplicationRegistry destRegistrybody = new ReplicationRegistry();
        destRegistrybody.withId(3L);
        body.withEnabled(true);
        body.withOverride(true);
        body.withTrigger(triggerbody);
        body.withRepoScopeMode("regular");
        body.withFilters(listbodyFilters);
        body.withDestNamespace("aa");
        body.withDestRegistry(destRegistrybody);
        body.withName("harbor-pull");
        request.withBody(body);
        try {
            CreateInstanceReplicationPolicyResponse response = client.createInstanceReplicationPolicy(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());
        }
    }
}

  • Creating a replication policy for pulling images from the target registry

     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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
    		 
    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 CreateInstanceReplicationPolicySolution {

    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();
        CreateInstanceReplicationPolicyRequest request = new CreateInstanceReplicationPolicyRequest();
        request.withInstanceId("{instance_id}");
        CreateReplicationPolicyRequestBody body = new CreateReplicationPolicyRequestBody();
        TriggerConfig triggerbody = new TriggerConfig();
        triggerbody.withType("manual");
        List<Filter> listbodyFilters = new ArrayList<>();
        listbodyFilters.add(
            new Filter()
                .withType("name")
                .withValue("aa/**")
        );
        listbodyFilters.add(
            new Filter()
                .withType("tag")
                .withValue("**")
        );
        ReplicationRegistry srcRegistrybody = new ReplicationRegistry();
        srcRegistrybody.withId(12L);
        body.withEnabled(true);
        body.withOverride(true);
        body.withTrigger(triggerbody);
        body.withRepoScopeMode("regular");
        body.withFilters(listbodyFilters);
        body.withDestNamespace("aa");
        body.withSrcRegistry(srcRegistrybody);
        body.withName("swr-pull");
        request.withBody(body);
        try {
            CreateInstanceReplicationPolicyResponse response = client.createInstanceReplicationPolicy(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

  • Creating a replication policy for pushing images to the target registry

     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
    		 
    # 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 = CreateInstanceReplicationPolicyRequest()
        request.instance_id = "{instance_id}"
        triggerbody = TriggerConfig(
            type="manual"
        )
        listFiltersbody = [
            Filter(
                type="name",
                value="library/**"
            ),
            Filter(
                type="tag",
                value="**"
            )
        ]
        destRegistrybody = ReplicationRegistry(
            id=3
        )
        request.body = CreateReplicationPolicyRequestBody(
            enabled=True,
            override=True,
            trigger=triggerbody,
            repo_scope_mode="regular",
            filters=listFiltersbody,
            dest_namespace="aa",
            dest_registry=destRegistrybody,
            name="harbor-pull"
        )
        response = client.create_instance_replication_policy(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

  • Creating a replication policy for pulling images from the target registry

     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
    		 
    # 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 = CreateInstanceReplicationPolicyRequest()
        request.instance_id = "{instance_id}"
        triggerbody = TriggerConfig(
            type="manual"
        )
        listFiltersbody = [
            Filter(
                type="name",
                value="aa/**"
            ),
            Filter(
                type="tag",
                value="**"
            )
        ]
        srcRegistrybody = ReplicationRegistry(
            id=12
        )
        request.body = CreateReplicationPolicyRequestBody(
            enabled=True,
            override=True,
            trigger=triggerbody,
            repo_scope_mode="regular",
            filters=listFiltersbody,
            dest_namespace="aa",
            src_registry=srcRegistrybody,
            name="swr-pull"
        )
        response = client.create_instance_replication_policy(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

  • Creating a replication policy for pushing images to the target registry

     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
62
63
64
65
66
    		 
    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.CreateInstanceReplicationPolicyRequest{}
	request.InstanceId = "{instance_id}"
	triggerbody := &model.TriggerConfig{
		Type: "manual",
	}
	var listFiltersbody = []model.Filter{
        {
            Type: "name",
            Value: "library/**",
        },
        {
            Type: "tag",
            Value: "**",
        },
    }
	destRegistrybody := &model.ReplicationRegistry{
		Id: int64(3),
	}
	overrideCreateReplicationPolicyRequestBody:= true
	destNamespaceCreateReplicationPolicyRequestBody:= "aa"
	request.Body = &model.CreateReplicationPolicyRequestBody{
		Enabled: true,
		Override: &overrideCreateReplicationPolicyRequestBody,
		Trigger: triggerbody,
		RepoScopeMode: "regular",
		Filters: listFiltersbody,
		DestNamespace: &destNamespaceCreateReplicationPolicyRequestBody,
		DestRegistry: destRegistrybody,
		Name: "harbor-pull",
	}
	response, err := client.CreateInstanceReplicationPolicy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

  • Creating a replication policy for pulling images from the target registry

     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
62
63
64
65
66
    		 
    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.CreateInstanceReplicationPolicyRequest{}
	request.InstanceId = "{instance_id}"
	triggerbody := &model.TriggerConfig{
		Type: "manual",
	}
	var listFiltersbody = []model.Filter{
        {
            Type: "name",
            Value: "aa/**",
        },
        {
            Type: "tag",
            Value: "**",
        },
    }
	srcRegistrybody := &model.ReplicationRegistry{
		Id: int64(12),
	}
	overrideCreateReplicationPolicyRequestBody:= true
	destNamespaceCreateReplicationPolicyRequestBody:= "aa"
	request.Body = &model.CreateReplicationPolicyRequestBody{
		Enabled: true,
		Override: &overrideCreateReplicationPolicyRequestBody,
		Trigger: triggerbody,
		RepoScopeMode: "regular",
		Filters: listFiltersbody,
		DestNamespace: &destNamespaceCreateReplicationPolicyRequestBody,
		SrcRegistry: srcRegistrybody,
		Name: "swr-pull",
	}
	response, err := client.CreateInstanceReplicationPolicy(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

201

The policy is created successfully.

400

Request error.

401

Authentication failed.

403

Access denied.

404

Resource not found.

500

Internal error.

Error Codes

See Error Codes.