GET
/
cloud
/
v1
/
reservations
Python
from gcore import Gcore

client = Gcore(
    api_key="My API Key",
)
page = client.cloud.billing_reservations.list()
page = page.results[0]
print(page.id)
{
  "count": 1,
  "results": [
    {
      "active_from": "2023-12-25",
      "active_to": "2023-12-25",
      "activity_period": "<string>",
      "activity_period_length": 123,
      "amount_prices": {
        "commit_price_per_month": "<string>",
        "commit_price_per_unit": "<string>",
        "commit_price_total": "<string>",
        "currency_code": "<string>",
        "overcommit_price_per_month": "<string>",
        "overcommit_price_per_unit": "<string>",
        "overcommit_price_total": "<string>"
      },
      "billing_plan_id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "error": "<string>",
      "eta": "2023-12-25",
      "id": 123,
      "is_expiration_message_visible": true,
      "name": "<string>",
      "next_statuses": [
        "<string>"
      ],
      "region_id": 123,
      "region_name": "<string>",
      "remind_expiration_message": "2024-01-01",
      "resources": [
        {
          "activity_period": "<string>",
          "activity_period_length": 123,
          "billing_plan_item_id": 123,
          "commit_price_per_month": "<string>",
          "commit_price_per_unit": "<string>",
          "commit_price_total": "<string>",
          "cpu": "<string>",
          "disk": "<string>",
          "overcommit_billing_plan_item_id": 123,
          "overcommit_price_per_month": "<string>",
          "overcommit_price_per_unit": "<string>",
          "overcommit_price_total": "<string>",
          "ram": "<string>",
          "resource_count": 123,
          "resource_name": "<string>",
          "resource_type": "flavor",
          "unit_name": "<string>",
          "unit_size_month": "<string>",
          "unit_size_total": "<string>"
        }
      ],
      "status": "ACTIVATED",
      "user_status": "ACTIVATED"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Query Parameters

​
activated_from
string<date>

Lower bound, starting from what date the reservation was/will be activated

​
activated_to
string<date>

High bound, before what date the reservation was/will be activated

​
created_from
string<date-time>

Lower bound the filter, showing result(s) equal to or greater than date the reservation was created

​
created_to
string<date-time>

High bound the filter, showing result(s) equal to or less date the reservation was created

​
deactivated_from
string<date>

Lower bound, starting from what date the reservation was/will be deactivated

​
deactivated_to
string<date>

High bound, before what date the reservation was/will be deactivated

​
limit
integer
default:10

Limit of reservation list page

Required range: x >= 1
​
metric_name
string

Name from billing features for specific resource

​
offset
integer
default:0

Offset in reservation list

Required range: x >= 0
​
order_by
enum<string>

Order by field and direction.

Available options:
active_from.asc,
active_from.desc,
active_to.asc,
active_to.desc,
created_at.asc,
created_at.desc
​
region_id
integer

Region for reservation

​
status
enum<string>[]

Field for fixed a status by reservation workflow

Response

200 - application/json

OK

The response is of type object.