Develop > Application Programming Interface > Legacy APIs > Utilization API

Utilization API

Use this API to retrieve a list of resource utilization objects for the specified subscription.

Note This REST API is supported only for sequenced designs and not for topology designs.

Base URL

https://<host>:<port>/csa/rest

Details

URI /utilization/<subscription_id>

See List Subscriptions for User for information on obtaining subscription IDs.
Method GET
Parameters

userIdentifier=<user_id>
    Required; the user ID you want to use as credentials for this API call. See Get userIdentifier for the steps required to get the userIdentifier value.

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>

Send Help Center feedback