Get Cloud Details

• endpointId (Mandatory): This is a unique identifier of Cloud Endpoint created in HCL BigFix CLM. It can be any value either PlatformEntityId or Name of the Platform available on Manage Provisioning Platform screen.
• queryParams (Optional): It is used for filtering and sorting of records. It has three properties, which are as follows:
• Filter: To filter records based on column name received from output. E.g. Filter="keyname='keyvalue'"
• Sort Order: To define sorting order either ASC (Ascending) or DESC (descending). E.g. Sortorder="ASC".
• Page Number: To get the records for related page number. Eg. Pagenumber="1”
• Page Size: To get the number of records on selected page. Eg. Pagesize="10”
• For e.g.

  {"filter": "virtualMachines=’10’","sortorder": "desc", "pagenumber" : "1", "pagesize" : "10"}

• Authorization Key: The initial step that needs to be performed before consuming HCL BigFix CLM API is to obtain the Token Value for an authorization key. Once a Token value is obtained, it remains valid for all API calls made in a session. For more information on how to do that, refer Token API description.
• Content-type: application/json

A Sample Response:

{
"totalRecords": 1,
 "records": [
 {
 "entityId": "CLOUD-516BA9F1-407E-468C-9945-282F2B65BA7A",
 "actualIdOnEnvironment": "xxxxxx",
 "name": "Test",
 "platformEntityId": "SCVM2-8F1E78E7-04D3-4AAF-822F-4D9D1E63DACD",
 "virtualCpuCount": 10,
 "virtualCpuCountLimited": 18,
 "memory": 10240,
 "memoryLimited": 14.0,
 "storage": 10,
 "storageLimited": 244,
 "customQuota": 10,
 "customQuotaLimited": 6,
 "virtualMachinesLimited": 6,
 "virtualMachines": 10,
 "associatedServicePlans": [
 {
 "servicePlanId": "2",
 "servicePlanName": "silver"
 }
 ]
 }
 ]
}

• Result:
• entityId
• actualIdOnEnvironment
• name
• platformEntityId
• virtualCpuCount
• virtualCpuCountLimited
• memory
• memoryLimited
• storage
• storageLimited
• customQuota
• customQuotaLimited
• virtualMachinesLimited
• virtualMachines
• associatedServicePlans