Sign in

v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
Snapshot Schedules

Check snapshot policy quota

Calculate the maximum resource usage if all snapshots are created by the policy.

post/cloud/v1/lifecycle_policy/{project_id}/{region_id}/estimate_max_policy_usage

Path parameters

project_idinteger required

Project ID

Example:1

Project ID

region_idinteger required

Region ID

Example:1

Region ID

Request body

action'volume_snapshot' required
namestring required

Name of the lifecycle policy.

status'active' | 'paused'
volume_idsstring[]

List of volume IDs.

Example request

{
  "name": "schedule_1",
  "schedules": [
    {
      "day": "5",
      "day_of_week": "mon,fri",
      "hour": "0, 20",
      "max_quantity": 2,
      "minute": "30",
      "month": "1,6",
      "resource_name_template": "Snapshot of volume {volume_id} created by policy {lifecycle_policy_id}",
      "retention_time": {
        "hours": 2,
        "minutes": 1
      },
      "timezone": "UTC",
      "type": "cron",
      "week": "1"
    }
  ],
  "volume_ids": [
    "3ed9e2ce-f906-47fb-ba32-c25a3f63df4f"
  ]
}

Response

OK

max_volume_snapshot_count_usageinteger required

Count of snapshots that can be created if the schedule creates the maximum possible number of snapshots.

max_volume_snapshot_sequence_lengthinteger required

Maximum volume snapshot sequence length.

max_volume_snapshot_size_usageinteger required

The amount of memory in GiB that snapshots will take up if the schedule creates the maximum possible number of them.

Example response

{
  "max_cost": {
    "currency_code": "USD",
    "discount_percent": 0.16,
    "price_per_hour": 1,
    "price_per_month": 720,
    "price_status": "show",
    "price_without_discount_per_month": 604.8,
    "tax_percent": 17
  },
  "max_volume_snapshot_count_usage": 2,
  "max_volume_snapshot_sequence_length": 2,
  "max_volume_snapshot_size_usage": 20
}