Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Search for | Example | Results |
---|---|---|
A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
- Legacy APIs
- Artifact API
- Availablevalues API
- Catalog API
- Export API
- Import API
- Import_result API
- Lifecycle engine API
- Login API
- Notification API
- Organization API
- orgInformation API
- Processinstances API
- Resource Provider API
- Search API
- User API
- Utilization API
- Values for the detail parameter
- Values for the excludedoc parameter
- Values for the scope parameter
- Values for the restrict parameter
- Primitive values reset to default
Utilization API
Use this API to retrieve a list of resource utilization objects for the specified subscription.
Base URL
https://<host>:<port>/csa/rest
Details
URI | /utilization/<subscription_id>
See List subscriptions for userfor information on obtaining subscription IDs. |
---|---|
Method | GET |
Parameters |
|
Returns | 200 - Ok 401 - Not authorized 404 - Not found 500 - Server exception |
Example use context
An organization’s policy is to do resource provider selection based on available capacity for all providers. The information returned by this API can be used to determine what resources are already in use.
Example
The following URL was sent:
https://<host>:<port>/csa/rest/utilization/90cec3a03a667c69013a6d7f0eea2cb3
The following XML was returned in the response:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<UtilizationList
<utilization>
<resourceBindingId>90e72d913d936a9a013d937bdb570161</resourceBindingId>
<resourcePool>
<id>90e72d913d936a9a013d936c74040006</id>
<objectId>90e72d913d936a9a013d936c74040006</objectId>
<isCriticalSystemObject>false</isCriticalSystemObject>
<name>Pool_1_March 22, 2013 6:46:31 PM UTC</name>
<displayName>Pool 1</displayName>
<disabled>false</disabled>
<poolReference>poolref</poolReference>
</resourcePool>
<resourceProvider>
<id>90e72d913d936a9a013d936c262b0004</id>
<objectId>90e72d913d936a9a013d936c262b0004</objectId>
<isCriticalSystemObject>false</isCriticalSystemObject>
<name>Provider_1_March 22, 2013 6:46:11 PM UTC</name>
<displayName>Provider 1</displayName>
<disabled>false</disabled>
</resourceProvider>
<resourceType>
<id>6A883A543D1248DDBB6045AD6A06BEA2</id>
<isCriticalSystemObject>true</isCriticalSystemObject>
<description>Megabytes of memory</description>
<name>MEMORY</name>
<displayName>Memory</displayName>
<disabled>false</disabled>
</resourceType>
<serviceComponentId>90e72d913d936a9a013d937bdb56015a</serviceComponentId>
<serviceInstanceId>90e72d913d936a9a013d937bdb530138</serviceInstanceId>
<unit>
<id>ED2CE3264F764F55877EE0CDFEE0EFB4</id>
<isCriticalSystemObject>true</isCriticalSystemObject>
<description>Megabytes</description>
<name>MB</name>
<displayName>MB</displayName>
<disabled>false</disabled
</unit>
<usage>1024</usage>
</utilization>
<utilization> … </utilization>
<utilization> … </utilization>
…
</UtilizationList>
We welcome your comments!
To open the configured email client on this computer, open an email window.
Otherwise, copy the information below to a web mail client, and send this email to clouddocs@hpe.com.
Help Topic ID:
Product:
Topic Title:
Feedback: