Get information about all systems subject to query parameters.

get/private-cloud-business/v1beta1/systems

Returns the systems and their properties defined by 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 a system. For example, to get details of the id, name and software information for each system, use ‘?select=id,name,softwareInfo’

Securitybearer
Request
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. Although systemVms collection can be selected, selecting elements of the collection is not supported.

Example: select=id,name,softwareInfo
offset
integer

Use offset in conjunction with limit for paging, e.g.: offset=30&&limit=10. Offset is the number of items from the beginning of the result set to the first item included in the response.

Example: offset=30
limit
integer <int32> [ 10 .. 100 ]
Default: 10

Use limit in conjunction with offset for paging, e.g.: offset=30&&limit=10. Limit is the maximum number of items to include in the response.

Example: limit=10
filter
string

The expression to filter responses. This API doesn't support filtering based on hypervisorClusters collection property, softwareInfo.hypervisorClusters and systemVms collection property. Request with filter based on the above mentioned properties will be treated as a Bad Request with 400 Error.

Example: filter=health/overallHealth eq OK
sort
string

A comma separated list of properties to sort by, followed by a direction indicator ("asc" or "desc"). If no direction indicator is specified the default order is ascending. This API doesn't support sorting based on hypervisorClusters collection property, softwareInfo.hypervisorClusters collection property and systemVms collection property. Request with sort based on the above mentioned properties will be treated as a Bad Request with 400 Error.

Example: sort=id desc,name asc
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
{
  • "items": [
    ],
  • "count": 0,
  • "offset": 0,
  • "total": 0
}