Obtaining Image Retention Records_Image Retention Policy Management_APIs_API Reference (Basic Edition)_SoftWare Repository for Container-Huawei Cloud

Function

Obtain image retention records.

Constraints

None

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

swr:repo:listRetentionHistories

List

repo *

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
swr:repo:listRetentionHistories	List	repo *	-	-	-

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
namespace	Yes	String	Organization name. Enter 1 to 64 characters, starting with a lowercase letter and ending with a lowercase letter or digit. Only lowercase letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. Periods, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed.
repository	Yes	String	Image repository name. The name contains 1 to 128 characters, starting and ending with a lowercase letter or digit. Only lowercase letters, digits, periods (.), slashes (/), underscores (_), and hyphens (-) are allowed. Periods, slashes, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed. If the parameter value contains a slash (/), replace it with a dollar sign ($) before sending the request.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	String	Number of returned records. Parameters offset and limit should always be used together.
offset	No	String	Start index. Parameters offset and limit should always be used together.
filter	No	String	Enter limit::{limit}\|offset::{offset}. {limit} indicates the number of returned records, and {offset} indicates the start index. Parameters offset and limit should be used together.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format). Possible values: application/json;charset=utf-8 application/json
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

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

**Table 5** Response body parameters
Parameter	Type	Description
retention_log	Array of RetentionLog objects	Image retention log
total	Integer	Total number

**Table 6** RetentionLog
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 Requests

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

Example Responses

Status code: 200

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

Status Codes

Status Code	Description
200	Request succeeded.
400	A request error occurred.
401	Authentication failed.
404	The organization or the repository does not exist.
500	An internal error occurred.

Error Codes

See Error Codes.

Obtaining Image Retention Records