Managed Service for MongoDB API, REST: BackupRetentionPolicy.Create
Add a new retention policy.
HTTP request
POST https://mdb.api.cloud.yandex.net/managed-mongodb/v1/clusters/{clusterId}/retention_policies
Path parameters
|
Field |
Description |
|
clusterId |
string Required field. ID of the mongodb cluster. The maximum string length in characters is 50. |
Body parameters
{
"cron": {
"dayOfMonth": "string",
"month": "string",
"dayOfWeek": "string"
},
"retainForDays": "string",
"description": "string",
"policyName": "string"
}
|
Field |
Description |
|
cron |
CronTab schedule. |
|
retainForDays |
string (int64) Retention duration. |
|
description |
string Policy description. |
|
policyName |
string Required field. Required. Policy name. |
CronTab
Message to describe a crontab schedule.
|
Field |
Description |
|
dayOfMonth |
string Day of month in cron format. Valid values: 1-31, , ranges (1-15), steps (/2, 1-15/3), lists (1,15,28). |
|
month |
string Month in cron format. Valid values: 1-12, , ranges (1-6), steps (/3), lists (1,6,12). |
|
dayOfWeek |
string Day of week in cron format. Valid values: 0-7 (0 and 7 both mean Sunday), , ranges (1-5), steps (0-6/2), lists (1,3,5). |
Response
HTTP Code: 200 - OK
{
"policy": {
"policyId": "string",
"clusterId": "string",
"policyName": "string",
"createdAt": "string",
"cron": {
"dayOfMonth": "string",
"month": "string",
"dayOfWeek": "string"
},
"retainForDays": "string",
"description": "string"
}
}
|
Field |
Description |
|
policy |
Newly created BackupRetentionPolicy. |
BackupRetentionPolicy
Message to describe a retention policy for cluster backups.
|
Field |
Description |
|
policyId |
string Required field. Required. Policy ID. |
|
clusterId |
string Required field. Cluster ID. The maximum string length in characters is 50. |
|
policyName |
string Required field. Required. Policy name. |
|
createdAt |
string (date-time) Creation timestamp in RFC3339 text format. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
cron |
CronTab schedule. |
|
retainForDays |
string (int64) Retention duration. |
|
description |
string Human-readable description. |
CronTab
Message to describe a crontab schedule.
|
Field |
Description |
|
dayOfMonth |
string Day of month in cron format. Valid values: 1-31, , ranges (1-15), steps (/2, 1-15/3), lists (1,15,28). |
|
month |
string Month in cron format. Valid values: 1-12, , ranges (1-6), steps (/3), lists (1,6,12). |
|
dayOfWeek |
string Day of week in cron format. Valid values: 0-7 (0 and 7 both mean Sunday), , ranges (1-5), steps (0-6/2), lists (1,3,5). |