更新时间:2026-09-28 GMT+08:00
分享

创建镜像老化规则 - CreateRetention

功能介绍

创建镜像老化规则

接口约束

无

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

namespace

是

String

参数解释:

组织名称。用于唯一标识一个组织,组织下的所有镜像仓库都属于该组织。

约束限制:

不涉及。

取值范围:

小写字母开头,后面跟小写字母、数字、小数点、下划线或中划线(其中下划线最多允许连续两个,不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~64个字符。

默认取值:

不涉及。

repository

是

String

参数解释:

镜像仓库名称过滤关键字,用于模糊匹配镜像仓库列表。与精确匹配的name参数不同,filter支持模糊查询。

约束限制:

不涉及。

取值范围:

小写字母或数字开头,后面跟小写字母、数字、小数点、斜杠、下划线或中划线(其中下划线最多允许连续两个,不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~128个字符。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

参数解释:

消息体的类型(格式),用于指定请求体的MIME类型。

约束限制:

不涉及。

取值范围:

  • application/json;charset=utf-8:使用UTF-8字符集的JSON格式

  • application/json:标准JSON格式

默认取值:

不涉及。

X-Auth-Token

是

String

参数解释:

用户Token。用于调用API时的鉴权。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

algorithm

是

String

参数解释:

回收规则匹配策略。

约束限制:

不涉及。

取值范围:

  • or:多条规则之间为「或」关系,满足任一规则即触发回收

默认取值:

不涉及。

rules

是

Array of Rule objects

参数解释:

镜像老化规则列表。

约束限制:

最多1条规则。

取值范围:

不涉及。

默认取值:

不涉及。

表4 Rule

参数

是否必选

参数类型

描述

template

是

String

参数解释:

回收类型。

约束限制:

不涉及。

取值范围:

  • date_rule:按日期规则回收

  • tag_rule:按版本规则回收

默认取值:

不涉及。

params

是

Object

参数解释:

老化规则参数。根据template的值不同,params的内容不同。template为date_rule时,params包含days字段(存活天数);template为tag_rule时,params包含num字段(保留版本数)。

例如:template为date_rule时:{"days": 30},template为tag_rule时:{"num": 5}。

约束限制:

不涉及。

取值范围:

包含days字段(Integer类型,存活天数,template为date_rule时有效)和num字段(Integer类型,保留版本数,template为tag_rule时有效)。

默认取值:

不涉及。

tag_selectors

是

Array of TagSelector objects

参数解释:

例外镜像列表。匹配的镜像不会被回收。列表元素为TagSelector对象,包含匹配规则类型kind及匹配模式pattern,参见TagSelector数据类型。

约束限制:

最多100个label匹配规则和1个正则匹配规则。

取值范围:

不涉及。

默认取值:

不涉及。

表5 TagSelector

参数

是否必选

参数类型

描述

kind

是

String

参数解释:

匹配规则类型。

约束限制:

不涉及。

取值范围:

  • label:按镜像版本匹配

  • regexp:按正则表达式匹配

默认取值:

不涉及。

pattern

是

String

参数解释:

匹配模式。根据kind的值不同,pattern的内容不同。

约束限制:

不涉及。

取值范围:

  • kind为label时:镜像版本名称

  • kind为regexp时:有效的正则表达式,长度不超过128个字符

默认取值:

不涉及。

响应参数

状态码:201

表6 响应Body参数

参数

参数类型

描述

id

Integer

参数解释:

镜像老化规则id。

取值范围:

镜像老化规则ID。

请求示例

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

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

响应示例

状态码:201

{
  "id" : 34
}

SDK代码示例

SDK代码示例如下。

 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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

201

创建成功

400

错误的请求

401

鉴权失败

404

组织或镜像仓库不存在

500

内部错误

错误码

请参见错误码。

相关文档