Updated on 2026-09-23 GMT+08:00

Obtaining an Image Retention Policy Record

Function

Obtain the records of image retention policies.

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:getRetention

Read

repo *

-

-

-

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

URI

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

**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.
retention_id	Yes	Integer	Image retention policy ID

Request Parameters

**Table 2** 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 3** Response body parameters
Parameter	Type	Description
algorithm	String	Retention policy matching rule. The value is or.
id	Integer	ID
rules	Array of Rule objects	Image retention policy
scope	String	Reserved field

**Table 4** Rule
Parameter	Type	Description
template	String	Retention policy type. The value can be date_rule and tag_rule.
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 TagSelector objects	Exception image

**Table 5** TagSelector
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 the image tag. If kind is set to regexp, set this parameter to a regular expression.

Example Requests

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

Example Responses