Modifying an Image Retention Policy

Function

Modify an image retention policy.

URI

PATCH /v2/manage/namespaces/{namespace}/repos/{repository}/retentions/{retention_id}

Table 1 describes the parameters.

Request

• Request parameters

  Table 2 Request header parameters

  Parameter	Mandatory	Type	Description
  Content-Type	Yes	String	Message body type (format). The value can be application/json or charset=utf-8 application/json. The default value is application/json.
  X-Auth-Token	Yes	String	User token. The token can be obtained by calling an IAM API. 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 objects	Image retention policy.

  Table 4 rules parameter description

  Parameter	Mandatory	Type	Description
  template	Yes	String	Retention policy type. The value can be set 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 objects	Image tags that are not counted in the retention policy.

  Table 5 tag_selectors parameter description

  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 specific image tags. If kind is set to regexp, set this parameter to a regular expression.

• Example request

  PATCH https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/retentions/1093
  
  {
      "algorithm": "or",
      "rules": [
          {
              "template": "date_rule",
              "params": {
                  "days": "30"
              },
              "tag_selectors": [
                  {
                      "kind": "label",
                      "pattern": "v5"
                  },
                  {
                      "kind": "label",
                      "pattern": "1.0.1"
                  },
                  {
                      "kind": "regexp",
                      "pattern": "^123$"
                  }
              ]
          }
      ]
  }

Response

• Response parameters

  N/A

• Example response

  N/A

Status Code

Error Codes

For details, see Error Codes.