List Reservation Policies Example

GET /api/reservations/policies lists existing reservation policies. Use this information to obtain a reservation policy ID in preparation for updating or deleting the reservation policy.

curl Command

List all available reservation policies. 

curl --insecure -H "Accept:application/json" 
-H "Authorization: Bearer $token" 
https://$vRA/reservation-service/api/reservations/policies

JSON Output

The following example output lists two reservation policies, named reservationPolicyTest and reservationPolicyTest2. Use the id value for each reservation policy to update or delete them. See Update a Reservation Policy Exampleand Deleting a Reservation Policy Example. 

{
  "links": [],
  "content": [{
    "@type": "ReservationPolicy",
    "id": "8adafb54-4c85-4478-86f0-b6ae80ab5ca4",
    "name": "reservationPolicyTest",
    "description": "reservationPolicyDescTest",
    "reservationPolicyTypeId": "Infrastructure.Reservation.Policy.ComputeResource"
  },
  {
    "@type": "reservationPolicy",
    "id": "fdd9854b-012e-41d7-ad17-fc73d4395714",
    "name": "reservationPolicyTest2",
    "description": "reservationPolicyDescTest2",
    "reservationPolicyTypeId": "Infrastructure.Reservation.Policy.Storage"
  }],
  "metadata": {
    "size": 0,
    "totalElements": 2,
    "totalPages": 1,
    "number": 1,
    "offset": 0
  }
}

Input

Use the supported input parameters to control the command output.

Parameter Description
URL https://$vRA/reservation-service/api/reservations/policies
Method Get
$vRA

Specifies the appliance name and fully qualified domain name, or IP address of the vRealize Automation server.

$token

Specifies a valid HTTP bearer token with necessary credentials.

Output

The command output contains property names and values based on the command input parameters.

Property Description
Links Specifies an array of link objects, each of which contains the following parts:
  • rel

    Specifies the name of the link.

    • Self refers to the object which was returned or requested.
    • First, Previous, Next, and Last refer to corresponding pages of pageable lists.
    • Specifies the application or service that determines the other names.
  • href

    Specifies the URL that produces the result.

Content Specifies an array of data rows, each of which represents one of the tenant objects returned in a pageable list. Each tenant object contains the following information:
  • @type. Contains the ReservationPolicy string.
  • id. Specifies the unique reservation policy ID.
  • name. Specifies the reservation policy name.
  • description. Specifies the reservation policy description.
reservationPolicyTypeId Specifies the type of reservation policy. Supported vRealize Automation reservation policy types are Reservation.Policy.ComputeResource and Reservation.Policy.Storage.
Metadata Specifies the paging-related data:
  • Size. Specifies the maximum number of rows per page.
  • totalElements. Specifies the number of rows returned.
  • totalPages. Specifies the total number of pages of data available.
  • Number. Specifies the current page number.
  • Offset. Specifies the number of rows skipped.