Updated on 2026-09-23 GMT+08:00

Adding an Image Retention Policy

Function

Add an image retention policy.

Constraints

None

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    swr:repo:createRetention

    Write

    repo *

    -

    -

    -

URI

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

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. The name contains 1 to 128 characters, starting and ending with a lowercase letter or digit. Only lowercase letters, digits, periods (.), slashes (/), underscores (_), and hyphens (-) are allowed. Periods, slashes, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed. If the parameter value contains a slash (/), replace it with a dollar sign ($) before sending the request.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format). Possible values:

application/json;charset=utf-8

application/json

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

Retention policy matching rule. The value is or.

rules

Yes

Array of Rule objects

Image retention policy

Table 4 Rule

Parameter

Mandatory

Type

Description

template

Yes

String

Retention policy type. The value can be date_rule and tag_rule.

params

Yes

Object

If template is set to date_rule, set params to {"days": "xxx"}.

If template is set to tag_rule, set params to {"num": "xxx"}.

tag_selectors

Yes

Array of TagSelector objects

Exception image

Table 5 TagSelector

Parameter

Mandatory

Type

Description

kind

Yes

String

Matching rule. The value can be label or regexp.

pattern

Yes

String

If kind is set to label, set this parameter to the image tag. If kind is set to regexp, set this parameter to a regular expression.

Response Parameters

Status code: 201

Table 6 Response body parameters

Parameter

Type

Description

id

Integer

Image retention policy ID

Example Requests

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

{
  "algorithm" : "string",
  "rules" : [ {
    "params" : { },
    "tag_selectors" : [ {
      "kind" : "string",
      "pattern" : "string"
    } ],
    "template" : "string"
  } ]
}

Example Responses

Status code: 201

{
  "id" : 34
}

SDK Sample Code

The SDK sample code is as follows.

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

    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("<YOUR REGION>"))
                .build();
        CreateRetentionRequest request = new CreateRetentionRequest();
        request.withNamespace("{namespace}");
        request.withRepository("{repository}");
        CreateRetentionRequestBody body = new CreateRetentionRequestBody();
        List<TagSelector> listRulesTagSelectors = new ArrayList<>();
        listRulesTagSelectors.add(
            new TagSelector()
                .withKind("string")
                .withPattern("string")
        );
        List<Rule> listbodyRules = new ArrayList<>();
        listbodyRules.add(
            new Rule()
                .withTemplate(Rule.TemplateEnum.fromValue("string"))
                .withParams(new Object())
                .withTagSelectors(listRulesTagSelectors)
        );
        body.withRules(listbodyRules);
        body.withAlgorithm("string");
        request.withBody(body);
        try {
            CreateRetentionResponse response = client.createRetention(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
39
40
41
42
43
44
45
46
47
48
49
# 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"]

    credentials = BasicCredentials(ak, sk)

    client = SwrClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SwrRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateRetentionRequest()
        request.namespace = "{namespace}"
        request.repository = "{repository}"
        listTagSelectorsRules = [
            TagSelector(
                kind="string",
                pattern="string"
            )
        ]
        listRulesbody = [
            Rule(
                template="string",
                params={},
                tag_selectors=listTagSelectorsRules
            )
        ]
        request.body = CreateRetentionRequestBody(
            rules=listRulesbody,
            algorithm="string"
        )
        response = client.create_retention(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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := swr.SwrClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := swr.NewSwrClient(hcClient)

    request := &model.CreateRetentionRequest{}
	request.Namespace = "{namespace}"
	request.Repository = "{repository}"
	var listTagSelectorsRules = []model.TagSelector{
        {
            Kind: "string",
            Pattern: "string",
        },
    }
	paramsRules:= make(map[string]string)
	var paramsRulesInterface interface{} = paramsRules
	var listRulesbody = []model.Rule{
        {
            Template: model.GetRuleTemplateEnum().STRING,
            Params: &paramsRulesInterface,
            TagSelectors: listTagSelectorsRules,
        },
    }
	request.Body = &model.CreateRetentionRequestBody{
		Rules: listRulesbody,
		Algorithm: "string",
	}
	response, err := client.CreateRetention(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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 creation succeeded.

400

A request error occurred.

401

Authentication failed.

404

The organization or the repository does not exist.

500

An internal error occurred.

Error Codes

See Error Codes.