7.2
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- Overview of the vRealize Automation REST API
- REST API Authentication
- REST API Use Cases
- Create a Tenant
- Syntax for Displaying Your Current Tenants
- Syntax for Requesting a New Tenant
- Syntax for Listing All Tenant Identity Stores
- Syntax for Linking an Identity Store to the Tenant
- Syntax for Searching LDAP or Active Directory for a User
- Syntax for Assigning a User to a Role
- Syntax for Displaying all Roles Assigned to a User
- Request a Machine
- Approve a Machine Request
- List Provisioned Resources
- Manage Provisioned Deployments
- Working with Reservations
- Create a Reservation
- Display a List of Supported Reservation Types
- Displaying a Schema Definition for a Reservation
- Get the Business Group ID for a Reservation
- Get a Compute Resource for the Reservation
- Getting a Resources Schema by Reservation Type
- Creating a Reservation By Type
- Verify a Reservation and Get Reservation Details
- Display a List of Reservations
- Update a Reservation
- Delete a Reservation
- Create a Reservation
- Working with Reservation Policies
- Working with Key Pairs
- Working with Network Profiles
- Get a List of Available IP Ranges for an IPAM Provider
- Import and Export Content
- Syntax for Listing Supported Content Types
- Syntax for Listing Available Content
- Syntax for Filtering Content by Content Type
- Syntax for Creating a Package for Export
- Syntax for Listing Packages in the Content Service
- Syntax for Exporting a Package
- Syntax for Validating a Content Bundle Before Importing
- Syntax for Importing a Package
- Understanding Blueprint Schema
- Manage XaaS Content with Import and Export
- Create a Tenant
- Related Tools and Documentation
- Filtering and Formatting REST API Information
- Index
If a user who is not authorized to approve the request submits the request, the following error response is
received:
Command failed [Rest Error]: {Status code: 400}, {Error code: 12017} ,
{Error Source: null}, {Error Msg: User fritz@example.mycompany.com not authorized to
complete work item with ID 5e3e9519-78ea-4409-a52c-e4aa3bc56511.}, {System Msg:
User fritz@example.mycompany.com not authorized to complete Work item with id
5e3e9519-78ea-4409-a52c-e4aa3bc56511.}
Syntax for Updating Cost Information
You can use the composition service to update and display cost information for a deployment. The cost of a
deployment is based on which blueprint you request plus details of the specic request. For example, if the
blueprint allows for a range of CPU, memory, or storage values, the cost depends on the value requested.
Input
Use the supported input parameters to control the command output.
Parameter Description
URL
//$host/composition-
service/api/blueprints/$BlueprintId/costs/upfront
Method Post
$host Species the host name and fully qualied domain name or IP
address of the vRealize Automation identity server.
$token Species a valid HTTP bearer token with necessary
credentials.
HTTP Body Species the blueprint ID for the blueprint for which you are
requesting cost information and other information.
n
Blueprint ID: Species the blueprint ID.
n
requestedFor: The user for whom this request is being
made. Must be the fully qualied user ID.
n
subTenantId: Species the subtenant ID associated with
the blueprint
n
requestData: Species data that identies the blueprint
further.
n
entries
n
Key: The name of the machine on which the
blueprint resides.
n
value: Species key-value pairs that further
identify the blueprint, such as the type of the
value, the componentType ID for the item, the
classID of the value, and where the blueprint
resides. In turn, each entry contains an array of
key-value pairs that identify the type of data used
to compute the cost that is to be displayed.
n
Values: Species an array of type lters.
n
Entries: Species a list of key-value pairs
that specify the values to be used in
computing the cost. For example, the cluster,
CPU, and allocated memory to use.
Output
The command output contains property names and values based on the command input parameters.
Chapter 3 REST API Use Cases
VMware, Inc. 67