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

Modifying an Image Retention Policy

Function

This API is used to modify an image retention policy.

Constraints

None.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/instances/{instance_id}/namespaces/{namespace_name}/retention/policies/{policy_id}

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.

namespace_name

Yes

String

Namespace name.

policy_id

Yes

Integer

ID of an image retention policy.

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

algorithm

Yes

String

Algorithm. Currently, only or is supported.

enabled

Yes

Boolean

Whether to enable or disable all image retention policies.

rules

Yes

Array of RetentionRule objects

Matching rule, which consists of the repository, tag, and condition. The array length can only be 1.

trigger

Yes

TriggerConfig object

Triggering mode.

name

Yes

String

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

Table 4 RetentionRule

Parameter

Mandatory

Type

Description

priority

Yes

Integer

Priority. This field is reserved. The default value is 0.

disabled

No

Boolean

Whether to disable a policy.

action

Yes

String

Reserved field. Currently, retain is the only value.

template

Yes

String

Policy template type. The value can be latestPulledN, latestPushedK, nDaysSinceLastPush, or nDaysSinceLastPull.

params

Yes

Map<String,Object>

Retention parameters, which are used with template. For details, see the example request.

tag_selectors

Yes

Array of RetentionSelector objects

Artifact tag selector. Currently, the value length must be 1.

scope_selectors

Yes

Map<String,Array<RetentionSelector>>

Artifact repository selector. Currently, only repository is supported, and the value length must be 1.

repo_scope_mode

Yes

String

Repository selection method. This field is used in the frontend. The value can be regular or selection.

Table 5 RetentionSelector

Parameter

Mandatory

Type

Description

kind

Yes

String

Matching type. Currently, doublestar is the only value.

decoration

Yes

String

Selector matching type. The value is repoMatches for the artifact repository selector. For the artifact tag selector, the value can be matches or excludes.

pattern

Yes

String

Selector matching pattern. The maximum length is 512 characters. The regular expression can be nginx-* or {repo1, repo2}.

*: matches any field that does not contain a slash (/).

**: matches any field that contains a slash (/).

?: matches any single character except a slash (/).

{option 1, option 2, ...}: matches any of the options.

extras

No

String

Reserved field.

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

The image retention policy is updated successfully.

Status code: 400

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

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

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

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.

Example Requests

PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/namespaces/{namespace_name}/retention/policies/{policy_id}

{
  "algorithm" : "or",
  "enabled" : true,
  "rules" : [ {
    "priority" : 0,
    "action" : "retain",
    "repo_scope_mode" : "regular",
    "scope_selectors" : {
      "repository" : [ {
        "kind" : "doublestar",
        "decoration" : "repoMatches",
        "pattern" : "**"
      } ]
    },
    "tag_selectors" : [ {
      "kind" : "doublestar",
      "decoration" : "matches",
      "pattern" : "**"
    } ],
    "disabled" : false,
    "params" : {
      "latestPushedK" : 10
    },
    "template" : "latestPushedK"
  } ],
  "trigger" : {
    "trigger_settings" : {
      "cron" : ""
    },
    "type" : "manual"
  },
  "name" : "test11"
}

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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
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;
import java.util.Map;
import java.util.HashMap;

public class UpdateInstanceRetentionPolicySolution {

    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();
        UpdateInstanceRetentionPolicyRequest request = new UpdateInstanceRetentionPolicyRequest();
        request.withInstanceId("{instance_id}");
        request.withNamespaceName("{namespace_name}");
        request.withPolicyId({policy_id});
        UpdateRetentionPolicyRequestBody body = new UpdateRetentionPolicyRequestBody();
        TriggerSetting triggerSettingsTrigger = new TriggerSetting();
        triggerSettingsTrigger.withCron("");
        TriggerConfig triggerbody = new TriggerConfig();
        triggerbody.withType("manual")
            .withTriggerSettings(triggerSettingsTrigger);
        List<RetentionSelector> listScopeSelectorsScopeSelectors = new ArrayList<>();
        listScopeSelectorsScopeSelectors.add(
            new RetentionSelector()
                .withKind("doublestar")
                .withDecoration("repoMatches")
                .withPattern("**")
        );
        Map<String, List<RetentionSelector>> listRulesScopeSelectors = new HashMap<>();
        listRulesScopeSelectors.put("repository", listScopeSelectorsScopeSelectors);
        List<RetentionSelector> listRulesTagSelectors = new ArrayList<>();
        listRulesTagSelectors.add(
            new RetentionSelector()
                .withKind("doublestar")
                .withDecoration("matches")
                .withPattern("**")
        );
        Map<String, Object> listRulesParams = new HashMap<>();
        listRulesParams.put("latestPushedK", "10");
        List<RetentionRule> listbodyRules = new ArrayList<>();
        listbodyRules.add(
            new RetentionRule()
                .withPriority(0)
                .withDisabled(false)
                .withAction("retain")
                .withTemplate("latestPushedK")
                .withParams(listRulesParams)
                .withTagSelectors(listRulesTagSelectors)
                .withScopeSelectors(listRulesScopeSelectors)
                .withRepoScopeMode("regular")
        );
        body.withName("test11");
        body.withTrigger(triggerbody);
        body.withRules(listbodyRules);
        body.withEnabled(true);
        body.withAlgorithm("or");
        request.withBody(body);
        try {
            UpdateInstanceRetentionPolicyResponse response = client.updateInstanceRetentionPolicy(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
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
76
77
78
79
80
# 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 = UpdateInstanceRetentionPolicyRequest()
        request.instance_id = "{instance_id}"
        request.namespace_name = "{namespace_name}"
        request.policy_id = {policy_id}
        triggerSettingsTrigger = TriggerSetting(
            cron=""
        )
        triggerbody = TriggerConfig(
            type="manual",
            trigger_settings=triggerSettingsTrigger
        )
        listScopeSelectorsScopeSelectors = [
            RetentionSelector(
                kind="doublestar",
                decoration="repoMatches",
                pattern="**"
            )
        ]
        listScopeSelectorsRules = {
            "repository": listScopeSelectorsScopeSelectors
        }
        listTagSelectorsRules = [
            RetentionSelector(
                kind="doublestar",
                decoration="matches",
                pattern="**"
            )
        ]
        listParamsRules = {
            "latestPushedK": "10"
        }
        listRulesbody = [
            RetentionRule(
                priority=0,
                disabled=False,
                action="retain",
                template="latestPushedK",
                params=listParamsRules,
                tag_selectors=listTagSelectorsRules,
                scope_selectors=listScopeSelectorsRules,
                repo_scope_mode="regular"
            )
        ]
        request.body = UpdateRetentionPolicyRequestBody(
            name="test11",
            trigger=triggerbody,
            rules=listRulesbody,
            enabled=True,
            algorithm="or"
        )
        response = client.update_instance_retention_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

 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
76
77
78
79
80
81
82
83
84
85
86
87
88
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.UpdateInstanceRetentionPolicyRequest{}
	request.InstanceId = "{instance_id}"
	request.NamespaceName = "{namespace_name}"
	request.PolicyId = int32({policy_id})
	cronTriggerSettings:= ""
	triggerSettingsTrigger := &model.TriggerSetting{
		Cron: &cronTriggerSettings,
	}
	triggerbody := &model.TriggerConfig{
		Type: "manual",
		TriggerSettings: triggerSettingsTrigger,
	}
	var listScopeSelectorsScopeSelectors = []model.RetentionSelector{
        {
            Kind: "doublestar",
            Decoration: "repoMatches",
            Pattern: "**",
        },
    }
	var listScopeSelectorsRules = map[string][](model.RetentionSelector){
        "repository": listScopeSelectorsScopeSelectors,
    }
	var listTagSelectorsRules = []model.RetentionSelector{
        {
            Kind: "doublestar",
            Decoration: "matches",
            Pattern: "**",
        },
    }
	var listParamsRules = map[string]interface{}{
        "latestPushedK": "10",
    }
	disabledRules:= false
	var listRulesbody = []model.RetentionRule{
        {
            Priority: int32(0),
            Disabled: &disabledRules,
            Action: "retain",
            Template: "latestPushedK",
            Params: listParamsRules,
            TagSelectors: listTagSelectorsRules,
            ScopeSelectors: listScopeSelectorsRules,
            RepoScopeMode: "regular",
        },
    }
	request.Body = &model.UpdateRetentionPolicyRequestBody{
		Name: "test11",
		Trigger: triggerbody,
		Rules: listRulesbody,
		Enabled: true,
		Algorithm: "or",
	}
	response, err := client.UpdateInstanceRetentionPolicy(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 image retention policy is updated successfully.

400

Request error.

401

Authentication failed.

403

Access denied.

404

Resource not found.

500

Internal error.

Error Codes

See Error Codes.