Obtaining an Image Retention Policy Record

Function

Obtain the details of an image retention policy.

URI

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

Table 1 describes the parameters.

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
namespace	Yes	String	Organization name.
repository	Yes	String	Image repository name.
retention_id	Yes	String	Image retention policy ID.

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.

Example request

GET https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/retentions/1093

Response

Response parameters

Status code: 200

**Table 3** Response body parameter description
Parameter	Type	Description
algorithm	String	Retention policy matching rule. The value is or.
id	Integer	Rule ID.
rules	Array of objects	Image retention policy.
scope	String	Reserved field.

**Table 4** rules parameter description
Parameter	Type	Description
template	String	Retention policy type. The value can be date_rule (number of days) or tag_rule (number of tags).
params	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	Array of objects	Image tags that are not counted in the retention policy.

**Table 5** tag_selectors parameter description
Parameter	Type	Description
kind	String	Matching rule. The value can be label or regexp.
pattern	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 response

Status code: 200

The image retention policy record is returned successfully.

{
    "algorithm": "or",
    "id": 1093,
    "rules": [
        {
            "template": "date_rule",
            "params": {
                "days": "30"
            },
            "tag_selectors": [
                {
                    "kind": "label",
                    "pattern": "v5"
                },
                {
                    "kind": "label",
                    "pattern": "1.0.1"
                },
                {
                    "kind": "regexp",
                    "pattern": "^123$"
                }
            ]
        }
    ],
    "scope": ""
}