Modifying an Image Retention Policy
Description
Modify an image retention policy.
Constraints
None
API Calling
For details, see Calling APIs.
URI
PATCH /v2/manage/namespaces/{namespace}/repos/{repository}/retentions/{retention_id}
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. Enter 1 to 128 characters. It must start and end 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. Replace a slash (/) with a dollar sign ($) before you send the request. |
retention_id |
Yes |
Integer |
Image retention policy ID. |
Request 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. Default value: application/json |
X-Auth-Token |
Yes |
String |
User token. The token 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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
algorithm |
Yes |
String |
Retention policy matching rule. The value is or. |
rules |
Yes |
Array of Rule objects |
Image retention policy. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
template |
Yes |
String |
Retention policy type. The value can be date_rule and tag_rule. This parameter cannot be changed. |
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 TagSelector objects |
Exception images. |
Response Parameters
None
Example Request
PATCH https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/retentions/{retention_id} { "algorithm" : "or", "rules" : [ { "params" : { "days" : "30" }, "tag_selectors" : [ { "kind" : "label", "pattern" : "v5" }, { "kind" : "label", "pattern" : "1.0.1" }, { "kind" : "regexp", "pattern" : "^123$" } ], "template" : "date_rule" } ] }
Example Response
None
Status Codes
Status Code |
Description |
---|---|
201 |
Update succeeded. |
400 |
Request error. |
401 |
Authentication failed. |
404 |
The organization, image repository, or policy was not found. |
500 |
Internal error. |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.