Связаться с намиПодключиться

BareMetal API, REST: RentalPeriod.List

Статья создана
Обновлена 30 октября 2025 г.

Retrieves the list of RentalPeriod resources.

HTTP request

GET https://baremetal.api.cloud.yandex.net/baremetal/v1alpha/rentalPeriods

Query parameters

Field

Description

configurationId

string

ID of the Configuration resource to return a Rental Period for.

To get the configuration ID, use a ConfigurationService.List request.

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is greater than page_size,
the service returns a ListRentalPeriodsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.
Default value is 20.

pageToken

string

Page token. To get the next page of results, set page_token to the
ListRentalPeriodsResponse.nextPageToken returned by a previous list request.

Response

HTTP Code: 200 - OK

{
  "rentalPeriods": [
    {
      "id": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

rentalPeriods[]

RentalPeriod

List of RentalPeriod resources.

nextPageToken

string

Token for getting the next page of the list. If the number of results is greater than
ListRentalPeriodsRequest.pageSize, use next_page_token as the value
for the [ListRentalPeriodsResponse.page_token] parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.

RentalPeriod

A period of time for which a Bare Metal Server can be rented. e.g., 1 month, 3 months, 6 months,
a year.

Field

Description

id

string

Rental period identifier.
Предыдущая
Overview
Следующая
Overview