BareMetal API, REST: RentalPeriod.List
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 |
|
pageToken |
string Page token. To get the next page of results, set |
Response
HTTP Code: 200 - OK
{
"rentalPeriods": [
{
"id": "string"
}
],
"nextPageToken": "string"
}
|
Field |
Description |
|
rentalPeriods[] |
List of RentalPeriod resources. |
|
nextPageToken |
string Token for getting the next page of the list. If the number of results is greater than Each subsequent page will have its own |
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. |