Updated on 2025-09-26 GMT+08:00

Listing Image Replication Policies

Function

This API is used to list the image replication policies.

Constraints

None.

Calling Method

For details, see Calling APIs.

URI

GET /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.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

order_column

No

String

Sorting field. The value can be created_at, updated_at, or name. The default value is created_at.

order_type

No

String

Sorting order. The value can be desc or asc. The default value is desc. This parameter must be used together with order_column.

name

No

String

Name, which can be used for fuzzy matching.

registry_id

No

Integer

Registry ID.

offset

No

Integer

Start index. The default value is 0. Note: The offset and limit parameters must be used together. The offset value must be 0 or a multiple of the limit value.

limit

No

Integer

Number of returned records. The default value is 10, and the maximum value is 100. Note: The offset and limit parameters must be used together. The offset value must be 0 or a multiple of the limit value.

Request Parameters

Table 3 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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

policies

Array of ReplicationPolicy objects

Replication policy list.

total

Integer

Total number of replication policies.

Table 5 ReplicationPolicy

Parameter

Type

Description

id

Integer

Policy ID.

name

String

Policy name.

description

String

Policy description.

src_registry

ReplicationRegistry object

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

dest_registry

ReplicationRegistry object

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

dest_namespace

String

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

filters

Array of Filter objects

Source resource filter.

repo_scope_mode

String

Repository filter type.

trigger

TriggerConfig object

Trigger configuration.

override

Boolean

Whether to overwrite an existing image tag.

enabled

Boolean

Whether to enable a resource.

created_at

String

Creation time.

updated_at

String

Update time.

Table 6 ReplicationRegistry

Parameter

Type

Description

id

Long

The registry ID.

Table 7 Filter

Parameter

Type

Description

type

String

Filter type. The options are name and tag.

value

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 8 TriggerConfig

Parameter

Type

Description

type

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

TriggerSetting object

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

Table 9 TriggerSetting

Parameter

Type

Description

cron

String

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

Status code: 400

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: 401

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: 403

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: 404

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.

Status code: 500

Table 14 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

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

Example Responses

Status code: 200

The list of image replication policies is queried successfully.

{
  "total" : 10,
  "policies" : [ {
    "id" : 20,
    "name" : "asfdf",
    "description" : "",
    "src_registry" : {
      "id" : 0
    },
    "dest_registry" : {
      "id" : 11
    },
    "repo_scope_mode" : "regular",
    "filters" : [ {
      "type" : "name",
      "value" : "root"
    }, {
      "type" : "tag",
      "value" : "**"
    } ],
    "dest_namespace" : "",
    "trigger" : {
      "type" : "manual",
      "trigger_settings" : {
        "cron" : ""
      }
    },
    "override" : true,
    "enabled" : true,
    "created_at" : "2020-12-03T11:55:14.338485Z",
    "updated_at" : "2020-12-03T11:55:14.338485Z"
  } ]
}

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
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 ListInstanceReplicationPoliciesSolution {

    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();
        ListInstanceReplicationPoliciesRequest request = new ListInstanceReplicationPoliciesRequest();
        request.withInstanceId("{instance_id}");
        try {
            ListInstanceReplicationPoliciesResponse response = client.listInstanceReplicationPolicies(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
# 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 = ListInstanceReplicationPoliciesRequest()
        request.instance_id = "{instance_id}"
        response = client.list_instance_replication_policies(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
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.ListInstanceReplicationPoliciesRequest{}
	request.InstanceId = "{instance_id}"
	response, err := client.ListInstanceReplicationPolicies(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

The list of image replication policies is queried successfully.

400

Request error.

401

Authentication failed.

403

Access denied.

404

Resource not found.

500

Internal error.

Error Codes

See Error Codes.