BareMetal API, gRPC: RentalPeriodService.List
Retrieves the list of RentalPeriod resources.
gRPC request
rpc List (ListRentalPeriodsRequest) returns (ListRentalPeriodsResponse)
ListRentalPeriodsRequest
{
"configuration_id": "string",
"page_size": "int64",
"page_token": "string"
}
|
Field |
Description |
|
configuration_id |
string ID of the Configuration resource to return a Rental Period for. To get the configuration ID, use a ConfigurationService.List request. |
|
page_size |
int64 The maximum number of results per page to return. If the number of available |
|
page_token |
string Page token. To get the next page of results, set |
ListRentalPeriodsResponse
{
"rental_periods": [
{
"id": "string"
}
],
"next_page_token": "string"
}
|
Field |
Description |
|
rental_periods[] |
List of RentalPeriod resources. |
|
next_page_token |
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. |