Get information about the specified system subject to query parameters.

get/private-cloud-business/v1beta1/systems/{id}

Returns the system properties specified in the query parameters. Retrieving all of the properties for the system can take a long time because the amount of data is large. Use the 'select' query parameter to choose only the properties you want to retrieve.

For example, to get details of the system's id, name and software information, use '?select=id,name,softwareInfo'

Securitybearer
Request
path Parameters
id
required
string <uuid>

Unique Identifier of the system, usually a UUID.

query Parameters
select
string

Query parameter listing the properties of system information to fetch. Although Hypervisor Clusters collection (property hypervisorClusters) can be selected, selecting elements of the collection is not supported. Similarly, hypervisor clusters update status collection (property softwareInfo.hypervisorClusters) can be selected, but, selecting elements of the collection is not supported in the select query parameter.

Example: select=select=id,name,softwareInfo,computeUsage,associatedResourceCount
Responses
200

Success

400

Bad Request

401

The current user is not authorized to perform the requested operation.

404

Not Found

500

Internal Server Error

Request samples 
Response samples 
application/json
{
  • "associatedResourceCounts": {
    },
  • "computeUsage": {
    },
  • "configAnalysisStatus": {
    },
  • "health": {
    },
  • "hypervisorClusters": [
    ],
  • "location": {
    },
  • "softwareInfo": {
    },
  • "stackType": "DHCI",
  • "state": "OFFLINE",
  • "storageSystem": {
    },
  • "storageUsage": {
    },
  • "systemVms": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "generation": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "resourceUri": "string",
  • "type": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}