Yandex Cloud Registry API, REST: LifecyclePolicy.Update
- HTTP request
- Path parameters
- Body parameters
- LifecycleRule
- KeepByAgeLifecycleRule
- KeepByVersionLifecycleRule
- DeleteLifecycleRule
- DeleteByVersionCondition
- DockerFilters
- MavenFilters
- Response
- UpdateLifecyclePolicyMetadata
- Status
- LifecyclePolicy
- LifecycleRule
- KeepByAgeLifecycleRule
- KeepByVersionLifecycleRule
- DeleteLifecycleRule
- DeleteByVersionCondition
- DockerFilters
- MavenFilters
Updates the specified lifecycle policy.
HTTP request
PATCH https://registry.api.yandexcloud.kz/cloud-registry/v1/lifecyclePolicies/{policyId}
Path parameters
|
Field |
Description |
|
policyId |
string Required field. ID of the lifecycle policy to update. |
Body parameters
{
"updateMask": "string",
"name": "string",
"description": "string",
"rules": [
{
"pathPrefix": "string",
// Includes only one of the fields `keepByAge`, `keepByVersion`, `delete`
"keepByAge": {
"youngerThanDays": "string"
},
"keepByVersion": {
"keepVersionsCount": "string"
},
"delete": {
"type": "string",
"cooldownPeriodDays": "string",
// Includes only one of the fields `olderThanDays`, `versionCondition`, `always`
"olderThanDays": "string",
"versionCondition": {
"versionsCountGreaterThan": "string"
},
"always": "boolean"
// end of the list of possible fields
},
// end of the list of possible fields
// Includes only one of the fields `dockerFilters`, `mavenFilters`
"dockerFilters": {
"tagStatus": "string"
},
"mavenFilters": {
"versionType": "string"
}
// end of the list of possible fields
}
],
"state": "string"
}
|
Field |
Description |
|
updateMask |
string (field-mask) A comma-separated names off ALL fields to be updated. If |
|
name |
string Name of the lifecycle policy. |
|
description |
string Description of the lifecycle policy. 0-1024 characters long. |
|
rules[] |
List of lifecycle rules. |
|
state |
enum (LifecyclePolicyState) State of the lifecycle policy.
|
LifecycleRule
A rule that defines lifecycle policy behavior.
|
Field |
Description |
|
pathPrefix |
string Path prefix to which the rule applies. |
|
keepByAge |
Rule that keeps artifacts by age. Includes only one of the fields Type of lifecycle rule. |
|
keepByVersion |
Rule that keeps artifacts by version count. Includes only one of the fields Type of lifecycle rule. |
|
delete |
Rule that deletes artifacts. Includes only one of the fields Type of lifecycle rule. |
|
dockerFilters |
Docker-specific filters. Includes only one of the fields Filters to determine which artifacts the rule applies to. |
|
mavenFilters |
Maven-specific filters. Includes only one of the fields Filters to determine which artifacts the rule applies to. |
KeepByAgeLifecycleRule
Rule that keeps artifacts younger than specified age.
|
Field |
Description |
|
youngerThanDays |
string (int64) Keep artifacts younger than this number of days. |
KeepByVersionLifecycleRule
Rule that keeps a specified number of recent versions.
|
Field |
Description |
|
keepVersionsCount |
string (int64) Number of versions to keep. |
DeleteLifecycleRule
Rule that deletes artifacts based on specified conditions.
|
Field |
Description |
|
type |
enum (DeleteLifecycleRuleKind) Type of deletion.
|
|
cooldownPeriodDays |
string (int64) Cooldown period in days before deletion. |
|
olderThanDays |
string (int64) Delete artifacts older than specified days. Includes only one of the fields Condition that triggers deletion. |
|
versionCondition |
Delete artifacts by version count condition. Includes only one of the fields Condition that triggers deletion. |
|
always |
boolean Always delete (use with caution). Includes only one of the fields Condition that triggers deletion. |
DeleteByVersionCondition
Condition for deletion based on version count.
|
Field |
Description |
|
versionsCountGreaterThan |
string (int64) Delete when version count exceeds this number. |
DockerFilters
Docker-specific filters for lifecycle rules.
|
Field |
Description |
|
tagStatus |
enum (TagStatus) Filter by tag status.
|
MavenFilters
Maven-specific filters for lifecycle rules.
|
Field |
Description |
|
versionType |
enum (VersionType) Filter by version type.
|
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"policyId": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": {
"id": "string",
"name": "string",
"description": "string",
"rules": [
{
"pathPrefix": "string",
// Includes only one of the fields `keepByAge`, `keepByVersion`, `delete`
"keepByAge": {
"youngerThanDays": "string"
},
"keepByVersion": {
"keepVersionsCount": "string"
},
"delete": {
"type": "string",
"cooldownPeriodDays": "string",
// Includes only one of the fields `olderThanDays`, `versionCondition`, `always`
"olderThanDays": "string",
"versionCondition": {
"versionsCountGreaterThan": "string"
},
"always": "boolean"
// end of the list of possible fields
},
// end of the list of possible fields
// Includes only one of the fields `dockerFilters`, `mavenFilters`
"dockerFilters": {
"tagStatus": "string"
},
"mavenFilters": {
"versionType": "string"
}
// end of the list of possible fields
}
],
"state": "string",
"registryId": "string",
"createdAt": "string",
"modifiedAt": "string",
"createdBy": "string",
"modifiedBy": "string"
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
|
Field |
Description |
|
id |
string ID of the operation. |
|
description |
string Description of the operation. 0-256 characters long. |
|
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
|
createdBy |
string ID of the user or service account who initiated the operation. |
|
modifiedAt |
string (date-time) The time when the Operation resource was last modified. String in RFC3339 To work with values in this field, use the APIs described in the |
|
done |
boolean If the value is |
|
metadata |
Service-specific metadata associated with the operation. |
|
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
|
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
UpdateLifecyclePolicyMetadata
|
Field |
Description |
|
policyId |
string Required field. ID of the lifecycle policy that is being updated. |
Status
The error result of the operation in case of failure or cancellation.
|
Field |
Description |
|
code |
integer (int32) Error code. An enum value of google.rpc.Code |
|
message |
string An error message. |
|
details[] |
object A list of messages that carry the error details. |
LifecyclePolicy
A LifecyclePolicy resource.
|
Field |
Description |
|
id |
string ID of the lifecycle policy. |
|
name |
string Name of the lifecycle policy. |
|
description |
string Description of the lifecycle policy. 0-1024 characters long. |
|
rules[] |
List of lifecycle rules. |
|
state |
enum (LifecyclePolicyState) Current state of the lifecycle policy.
|
|
registryId |
string ID of the registry that the lifecycle policy belongs to. |
|
createdAt |
string (date-time) Output only. Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
|
modifiedAt |
string (date-time) Output only. Modification timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
|
createdBy |
string Output only. ID of the user who created the lifecycle policy. |
|
modifiedBy |
string Output only. ID of the user who last modified the lifecycle policy. |
LifecycleRule
A rule that defines lifecycle policy behavior.
|
Field |
Description |
|
pathPrefix |
string Path prefix to which the rule applies. |
|
keepByAge |
Rule that keeps artifacts by age. Includes only one of the fields Type of lifecycle rule. |
|
keepByVersion |
Rule that keeps artifacts by version count. Includes only one of the fields Type of lifecycle rule. |
|
delete |
Rule that deletes artifacts. Includes only one of the fields Type of lifecycle rule. |
|
dockerFilters |
Docker-specific filters. Includes only one of the fields Filters to determine which artifacts the rule applies to. |
|
mavenFilters |
Maven-specific filters. Includes only one of the fields Filters to determine which artifacts the rule applies to. |
KeepByAgeLifecycleRule
Rule that keeps artifacts younger than specified age.
|
Field |
Description |
|
youngerThanDays |
string (int64) Keep artifacts younger than this number of days. |
KeepByVersionLifecycleRule
Rule that keeps a specified number of recent versions.
|
Field |
Description |
|
keepVersionsCount |
string (int64) Number of versions to keep. |
DeleteLifecycleRule
Rule that deletes artifacts based on specified conditions.
|
Field |
Description |
|
type |
enum (DeleteLifecycleRuleKind) Type of deletion.
|
|
cooldownPeriodDays |
string (int64) Cooldown period in days before deletion. |
|
olderThanDays |
string (int64) Delete artifacts older than specified days. Includes only one of the fields Condition that triggers deletion. |
|
versionCondition |
Delete artifacts by version count condition. Includes only one of the fields Condition that triggers deletion. |
|
always |
boolean Always delete (use with caution). Includes only one of the fields Condition that triggers deletion. |
DeleteByVersionCondition
Condition for deletion based on version count.
|
Field |
Description |
|
versionsCountGreaterThan |
string (int64) Delete when version count exceeds this number. |
DockerFilters
Docker-specific filters for lifecycle rules.
|
Field |
Description |
|
tagStatus |
enum (TagStatus) Filter by tag status.
|
MavenFilters
Maven-specific filters for lifecycle rules.
|
Field |
Description |
|
versionType |
enum (VersionType) Filter by version type.
|