更新时间:2025-08-05 GMT+08:00
分享

获取老化策略列表

功能介绍

获取老化策略列表

接口约束

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/instances/{instance_id}/retention/policies

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

instance_id

String

企业仓库实例ID

表2 Query参数

参数

是否必选

参数类型

描述

name

String

老化策略名称

namespace_id

Integer

所属命名空间ID

offset

Integer

起始索引,默认值为0。注意:offset和limit参数需要配套使用,offset必须为0或者为limit的倍数。

limit

Integer

返回条数,默认为10,最大值为100。注意:offset和limit参数需要配套使用,offset必须为0或者为limit的倍数。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total

Integer

策略总数

retentions

Array of ImageRetention objects

老化策略详情

表5 ImageRetention

参数

参数类型

描述

id

Integer

老化策略ID

algorithm

String

算法

rules

Array of RetentionRuleResponseBody objects

匹配规则

trigger

TriggerConfig object

触发方式

enabled

Boolean

是否开启策略

name

String

策略名称

namespace_id

Integer

命名空间ID

namespace_name

String

命名空间名

表6 RetentionRuleResponseBody

参数

参数类型

描述

id

Integer

镜像老化策略ID

priority

Integer

预留字段,目前只支持0

disabled

Boolean

是否关闭此条规则

action

String

预留字段,目前只支持retain

template

String

规则模板类型,值为:latestPulledN,latestPushedK,nDaysSinceLastPush,nDaysSinceLastPull

params

Map<String,Object>

保留方式的参数,配套template使用,可参考请求示例

tag_selectors

Array of RetentionSelector objects

制品版本选择器,目前只支持长度为1

scope_selectors

Map<String,Array<RetentionSelector>>

制品仓库选择器,目前只支持repository且长度为1

repo_scope_mode

String

repo选择模式,前端使用,可选regular、selection

表7 RetentionSelector

参数

参数类型

描述

kind

String

匹配类型,目前只支持doublestar

decoration

String

选择器匹配类型 制品仓库选择器可选repoMatches,repoMatches制品版本可选matches,excludes

pattern

String

选择器匹配样式,最大长度512。支持正则表达式,正则表达式规则可填写如 nginx-* ,{repo1,repo2} 等,其中:

  • : 匹配不包含 '/' 的任何字段。

**:匹配包含 '/' 的任何字段。

? :匹配任何单个非 '/' 的字符。

{选项1,选项2,...}:同时匹配多个选项。

extras

String

预留字段

表8 TriggerConfig

参数

参数类型

描述

type

String

触发类型,镜像签名、老化规则只支持manual(手动)、scheduled(定时+手动);同步策略支持manual(手动)、scheduled(定时+手动)、event_based(事件触发+手动)

trigger_settings

TriggerSetting object

触发设置,只有type为scheduled的时候,才需要设置

表9 TriggerSetting

参数

参数类型

描述

cron

String

定时设置,cron格式描述 '* * * * * *'。cron 基于 UTC 时间。

状态码:400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码:401

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码:403

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码:404

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码:500

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

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

响应示例

状态码:200

查询老化策略列表成功

{
  "total" : 3,
  "retentions" : [ {
    "id" : 34,
    "algorithm" : "or",
    "rules" : [ {
      "id" : 0,
      "priority" : 0,
      "disabled" : false,
      "action" : "retain",
      "template" : "latestPulledN",
      "repo_scope_mode" : "regular",
      "params" : {
        "latestPulledN" : 111
      },
      "tag_selectors" : [ {
        "kind" : "doublestar",
        "decoration" : "matches",
        "pattern" : "abc",
        "extras" : ""
      } ],
      "scope_selectors" : {
        "repository" : [ {
          "kind" : "doublestar",
          "decoration" : "repoMatches",
          "pattern" : "abc",
          "extras" : ""
        } ]
      }
    } ],
    "trigger" : {
      "type" : "scheduled",
      "trigger_settings" : {
        "cron" : "0 19 14 * * ?"
      }
    },
    "enabled" : true,
    "name" : "abc",
    "namespace_id" : 51,
    "namespace_name" : "abc"
  } ]
}

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

    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();
        ListInstanceRetentionPoliciesRequest request = new ListInstanceRetentionPoliciesRequest();
        request.withInstanceId("{instance_id}");
        try {
            ListInstanceRetentionPoliciesResponse response = client.listInstanceRetentionPolicies(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
# 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 = ListInstanceRetentionPoliciesRequest()
        request.instance_id = "{instance_id}"
        response = client.list_instance_retention_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)
 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.ListInstanceRetentionPoliciesRequest{}
	request.InstanceId = "{instance_id}"
	response, err := client.ListInstanceRetentionPolicies(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

查询老化策略列表成功

400

错误的请求

401

鉴权失败

403

禁止访问

404

未找到资源

500

内部错误

错误码

请参见错误码

相关文档