[{"label":"Latest (8.10.0)","version":"latest"},{"version":"8.6.3"}]
vrealize-operations

Get Resources

Description

Get a listing of resources based on the query spec specified

Request

Request

URL

URL


get
https://localhost/suite-api/api/resources
Copy

Query Parameters

Query Parameters

array
adapterInstanceId Optional

Array of uuids that identify adapter instances


array
adapterKind Optional

Array of Adapter Kind keys


array
collectorId Optional

Array of Collector Identifiers


array
collectorName Optional

Array of Collector names


array
credentialId Optional

Array of CredentialIDs


string
includeRelated Optional

None null value specifies to include related resource ids of given relationship type in resource result. Uses the RelationshipType.representation value.

Possible values are: PARENTCHILDCONTAINSCONTAINED_BYREFERENCESREFERENCED_BYUSESUSED_BYSELFDESCENDANTANCESTORTSTALL


array
maintenanceScheduleId Optional

Array of {@link UUID} that identify Maintenance Schedules. Since vROps 6.1.0 release onwards, we don’t support search and look up of Resources using Maintenance Schedules’ identifiers.


array
name Optional

Array of resource names to query for. NOTE: Currently, only single element supported


array
others Optional

integer
page Optional

Page number from which data needs to be displayed (0-based)


integer
pageSize Optional

Expected number of entries per page


array
parentId Optional

Array of UUID of object that are the parent resource in a parent child relationship


string
propertyName Optional

Name of property. Query only supports filtering for a single property.


string
propertyValue Optional

Value of property. Omitting the property value will check for existence of the property name on the resource. NOTE: Use ‘propertyConditions’ to specify lookup of Resource using multiple properties.


integer
recentlyAdded Optional

Return resources created after the specified value. Value is the number of seconds since Midnight January 1, 1970 GMT.


array
regex Optional

Array of resource names in java regex format. NOTE: regex and name are mutually exclusive. If both are specified, name is given preference.


array
resourceHealth Optional

Array of resource health

Possible values are: GREENYELLOWORANGEREDGREY


array
resourceId Optional

Array of Resource Identifiers


array
resourceKind Optional

Array of Resource Kind keys


array
resourceState Optional

Array of resource states

Possible values are: STOPPEDSTARTINGSTARTEDSTOPPINGUPDATINGFAILEDMAINTAINEDMAINTAINED_MANUALREMOVINGNOT_EXISTINGNONEUNKNOWN


array
resourceStatus Optional

Array of resource data collection stats

Possible values are: NONEERRORUNKNOWNDOWNDATA_RECEIVINGOLD_DATA_RECEIVINGNO_DATA_RECEIVINGNO_PARENT_MONITORINGCOLLECTOR_DOWN


string
statKey Optional

Name of resource StatKey to validate value is within a range. Use with statKeyLowerBound, statKeyUpperBound and statKeyInclusive to create comparison conditions NOTE: Use ‘statConditions’ to specify lookup of Resource using multiple stat keys.


boolean
statKeyInclusive Optional

Filtering by statKey values is inclusive or exclusive of boundary values. Defaults to true


number
statKeyLowerBound Optional

StatKey value matching range lower bound


number
statKeyUpperBound Optional

StatKey value matching range upper bound


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns Resources of type(s) application/json, application/xml

The Collection of Resources matching the specified query parameters

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://localhost/suite-api/api/resources


Feedback

Was this page helpful?