Obtaining Image Retention Records

Function

Obtain image retention records.

URI

GET /v2/manage/namespaces/{namespace}/repos/{repository}/retentions/histories?offset={offset}&limit={limit}

Table 1 describes the parameters.

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

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
filter	No	String	Set this parameter to limit::{limit}\|offset::{offset}. limit indicates the number of returned records. offset indicates the start index. Parameters offset and limit should always be used together.

Request

Request parameters

**Table 3** 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/histories

Response

Response parameters

Status code: 200

**Table 4** Response header parameter description
Parameter	Type	Description
Content-Range	String	Offset (Start index) – Count (Number of records on the current page)/Total (Total number of records)

If the offset and limit parameters are transferred in the request, Content-Range will be added to the response header.

**Table 5** Response body parameter description
Parameter	Type	Description
retention_log	Array of objects	Image retention log.
total	Integer	Total number.

**Table 6** retention_log parameter description
Parameter	Type	Description
created_at	String	Creation time
id	Integer	ID.
namespace	String	Organization name.
repo	String	Image repository name.
retention_id	Integer	Image retention policy ID.
rule_type	String	Policy.
tag	String	Image tag.

Example response

Status code: 200

The image retention records is returned successfully.

{
    "retention_log": [
        {
            "created_at": "2020-04-17T08:01:09.658309Z",
            "id": 9088,
            "namespace": "hwstaff_l00283074",
            "repo": "experience_2048",
            "retention_id": 91,
            "rule_type": "{\"template\":\"tag_rule\",\"params\":{\"num\":\"7\"},\"tag_selectors\":[]}",
            "tag": "4"
        }
    ],
    "total": 1
}